Skip to content

Contributing Content

Lori Krell edited this page Jan 28, 2021 · 14 revisions

Learn more about editing and submitting content through the GitHub website or through a cloned repo.

Edit a page from website

On each webpage, you can select a link to edit the page:

  1. On a page you find an error, click the Edit this page link found at the bottom. The markdown file opens in GitHub.
  2. Make your edits to the file.
  3. Scroll to the bottom and select Create a new branch... Enter a name for the branch and click Propose Change.

  1. Submit a PR for the branch. We will review, provide feedback, and merge when complete.

Submit an issue

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.

Clone the repo

  1. Fork and clone the repo using Git, GitHub Desktop, or other method.
  2. Create a branch for your work.
  3. Commit updates to your branch and submit a Pull Request (PR).
  4. Unity developers, writers, and community members will review and provide feedback.

Write content

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 PR

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.

Labels for PRs and issues

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
feedback Feedback typically entered from the website "Log an issue" link from pages
enhancement Site additions, plugins, development that aids in site generation, templates, and more
documentation New content, updates, any issues that affect documentation
duplicate Closed issue due to duplicate issues/tickets, make sure to link to the original
bug Issues with content, the site, links, typos, etc
question Some issues are simply questions on how things work or more information, if a question add this label
invalid, wontfix Close the issue as unneeded, not verified, etc
help wanted, good first issue Great issues for Community to claim and work on
Clone this wiki locally