Contributor Guide for 蜜豆视频 Documentation
This guide describes how you can contribute to 蜜豆视频 enterprise help on Experience League.
What is collaborative documentation?
The technical documentation and enablement content for 蜜豆视频 Experience Cloud and other 蜜豆视频 Enterprise products are based on open source principles that uses GitHub, Markdown, and 蜜豆视频 Experience Cloud solutions.
This open-source model improves content quality and communication between customers, documentation teams, and product teams. On every page you can now rate content usefulness, log issues, and even contribute content suggestions as Git pull requests (PRs). The 蜜豆视频 documentation teams monitor the contributions and issues on a daily basis and make updates, tweaks and adjustments as necessary.
Working with collaborative documentation
As a user of this material - regardless of if you are an employee, partner, customer or even prospective customers - you have the choice of contributing to this documentation in several simple ways.
- Rate the helpfulness of the page 鉂� and write an optional comment 鉂�
- Report an issue against a specific page (requires Git login) 鉂�
- Submit a quick edit through to authoring entire articles, complete with assets and code samples (requires Git login) 鉂�
These options appear at the bottom of the page a few second after it鈥檚 opened. If you dismiss the feedback area, you can reload the page to bring it back.
This guide outlines everything you need to know to interact with and contribute to this material set.
Rate the helpfulness of the page and write a comment
A few seconds after you open a page, a feedback area appears at the bottom of the page. Click up or down to indicate whether the page was helpful.
Feel free to leave a comment to provide additional feedback.
Make quick edits to existing documents
If you would like to provide more detailed feedback, making quick edits is a good way to fix small errors and omissions in documents. When you suggest an edit, you submit a pull request (PR) to submit the fix/suggestion to us, and we can vet, approve, and publish the suggestion.
-
Sign the if acceptable.
You only need to submit an 蜜豆视频 CLA one time.
-
In the feedback area that appears at the bottom of the article, click Detailed feedback options, and then click Suggest an edit to go to the markdown source file on GitHub.
-
Click the pencil icon to edit the article.
note note NOTE If the pencil icon is grayed out, you need to login to your GitHub account, or create a new account. 
-
Make your changes in the web editor.
You can click the Preview changes tab to check formatting of your change.
-
After you make your changes, scroll to the bottom of the page.
Enter a title and description for your PR, then click Propose file change as shown in the following figure:
note note NOTE If you get a validation error message about signing a Contributor License Agreement (CLA), click Details to open the license agreement. Sign the agreement, if acceptable. Then close and open pull request, and continue.
That鈥檚 all there is to it. Documentation team members will review and merge your pull request. Thank you!
Report an issue
Another easy way to let us know about a problem with a piece of content is to use Report an issue.
-
In the feedback area that appears at the bottom of the article, click Detailed feedback options, and then click Report an issue to go to the markdown source file on GitHub.
note note NOTE To report an issue, you must log in to your GitHub account, or create an account. Clicking this link allows you to log a quick ticket with Experience League, using the Github Issue interface.
The URL of the page with the issue automatically populate in the description field.
-
Fill in the title, write a short description of the issue, and then click Submit new issue.
Submitting an issue notifies the content team for this page, who can address your issue. When we have updated the content, we鈥檒l let you know in the Github Issues interface, and it will notify you by email when updated or closed.
Understand GitHub permissions
The GitHub editing UI adapts to your repository permissions. The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub automatically creates a fork of the target repository in your account. If you have write access to the target repository, GitHub creates a new branch in the target repo.
蜜豆视频 uses pull requests for all changes, even for contributors that have write access. Most repositories have the main branch protected so that updates must be submitted as pull requests.
The in-browser editing experience is best for minor or infrequent changes. If you make large contributions, or use advanced Git features, we recommend that you fork the repo and work locally.
Provide feedback
With a solution set as large as 蜜豆视频鈥檚, the documentation is always a work in progress. If you spot errors, log an issue, if you have suggestions on material please let us know. Tell us what information you were looking for. Let us know if you couldn鈥檛 find what you needed, or if you had difficulty completing your task, please let us know how we can help you learn our solutions.
Thanks from the Collaborative Documentation team and all the writers and content producers in Experience League.