daohualiuxiang
/
AspNetCore.Docs
mirror of https://github.com/dotnet/AspNetCore.Docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

pull/251/head
Mike Wasson 2015-05-20 10:58:02 -07:00
parent 2a78c60004
commit c8bf5a2a62
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -54,24 +54,25 @@ If contributing new documentation content, please review:
Before adding content, submit an issue with a suggestion for your proposed article. Provide detail on what the article would discuss, and how it would relate to existing documentation. Before adding content, submit an issue with a suggestion for your proposed article. Provide detail on what the article would discuss, and how it would relate to existing documentation.
Articles should be organized into logical groups or sections. Each section should be given a named folder (e.g. /yourfirst). Within each section, each article should also have its own folder, within which the article.rst file resides. Images and other static resources (code samples, etc.) should be placed in a _static folder within the article folder. Articles should be organized into logical groups or sections. Each section should be given a named folder (e.g. /yourfirst). That section contains the rst files for all articles in the section. For images and other static resources, create a subfolder that matches the name of the article. Within this subfolder, create a ``sample`` folder for code samples and a ``_static`` folder for images and other static content.
### Example Structure ### ### Example Structure ###
docs docs
/yourfirst /client-side
/fundamentalconcepts /angular
/_static
controllers.png
events.png
...
/sample
(sample code)
/bootstrap
/_static /_static
about-page.png about-page.png
add-config.png
... ...
fundamentalconcepts.rst angular.rst
/yourfirstaspnetapplication bootstrap.rst
/_static
about-page.png
add-api-controller.png
...
yourfirstaspnetapplication.rst
**Note:** Sphinx will automatically fix duplicate image names, such as the about-page.png files shown above. There is no need to try to ensure uniqueness of static files beyond an individual article. **Note:** Sphinx will automatically fix duplicate image names, such as the about-page.png files shown above. There is no need to try to ensure uniqueness of static files beyond an individual article.