Contributing Content
Learn more about editing and submitting content through the GitHub website or through a cloned repo.
On each webpage, you can select a link to edit the page:
- On a page you find an error, click the Edit this page link found at the bottom. The markdown file opens in GitHub.
- Make your edits to the file.
- Scroll to the bottom and select Create a new branch... Enter a name for the branch and click Propose Change.
- Submit a PR for the branch. We will review, provide feedback, and merge when complete.
If you find an issue on a page, or want to request more information, submit an issue. You can enter issues through GitHub or directly as feedback per page using the Log an issue link found at the bottom.
- Fork and clone the repo using Git, GitHub Desktop, or other method.
- Create a branch for your work.
- Commit updates to your branch and submit a Pull Request (PR).
- Unity developers, writers, and community members will review and provide feedback.
We have three important branches with Jenkins jobs that build to dedicated servers depending on the work and process.
| Branch | Usage | Unity Docs |
|---|---|---|
master |
Always cut branches from Master, the source of truth. You must submit a Pull Request (PR) to have work considered for merging to the site. | Unity Docs manages all PR merges. Please do not merge approved PRs. We will handle it! |
staging |
This prerelease branch will have content in a PR and ready for review/merge to the repo. We heavily test this branch strictly for prerelease for production. In-progress, development content should not be merged to this branch. | Unity Docs manages merges and maintaining the branch. Do not merge to this branch without a PR or completed reviews. |
sandbox |
Development branch for testing and previewing content and doc site features that are in-progress and experimental. | Unity Docs keeps this updated from master and can push branches to it for previews. |
Edit existing markdown files or create new files for content:
- Markdown (.md) content files are in /docs
- Images (.png) are in /static/img
- Static downloadable files such as scripts can be saved in /static
See Working with Markdown to learn more about creating files, using Markdown formats, adding images, adding navigation, and more.
Submit a PR for the branch. PRs use a template allowing you to select the type of change, enter the purpose and changes for the PR, and a link or number for an issue/ticket. This helps Unity review and prioritize reviews.
When complete, all PRs are reviewed, managed, and merged by Unity Technical Writers. We will expand to include maintainers as we grow.
| Label | Description |
|---|---|
enhancement |
Site additions, plugins, development that aids in site generation, templates, and more |
new content |
New topic markdown files for content, requires navigation additions |
update |
Updates to existing content and files, typically does not require navigation updates |
documentation |
New content, updates, any issues that affect documentation |
type:feedback |
Feedback typically entered from the website "Log an issue" link from pages |
type:feature |
Site additions, plugins, development that aids in site generation, templates, and more |
type:bug |
Issues with content, the site, links, typos, etc |
duplicate |
Closed issue due to duplicate issues/tickets, make sure to link to the original |
question |
Some issues are simply questions on how things work or more information, if a question add this label |
help wanted, good first issue
|
Great issues for Community to claim and work on |
Status labels:
| Label | Description |
|---|---|
stat:awaiting response |
Waiting for response from the author of a PR |
stat:awaiting triage |
Needs triaging from the docs team |
stat:backlog |
Work moved to the backlog for future work |
stat:committed |
Work has been triaged, considered, and accepted for work |
stat:in consideration |
Internal Unity review and consideration of the work |
stats:invalid, stat:wontfix
|
Close the issue as unneeded, not verified, etc |
Priority labels:
We will assign priority labels to best indicate highest to lowest importance for work. This will be initially determined with triage and updated as needed.