Skip to content

Commit

Permalink
Add documentation draft guides (RocketChat#727)
Browse files Browse the repository at this point in the history
* Add documentation draft guides

* Fix lint
  • Loading branch information
MartinSchoeler authored and engelgabriel committed May 5, 2018
1 parent 95d353d commit f6944ab
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 0 deletions.
3 changes: 3 additions & 0 deletions _data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
- Contribution Guidelines
- Markdown Styleguide
- Documentation Map
- Drafts:
- New Feature Draft
- Feature Change Draft
- Missing and Outdated List
- Community Maintainers
- Google Summer of Code 2017
Expand Down
1 change: 1 addition & 0 deletions contributing/documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Here you will find all that you need to know to start contributing to Rocket.Chat documentation.

- [Contribution Guidelines](contribution-guidelines/)
- [Drafts](drafts/)
- [Documentation Map](documentation-map/)
- [Markdown Styleguide](markdown-styleguide/)
- [Missing and Outdated List](missing-and-outdated-list/)
6 changes: 6 additions & 0 deletions contributing/documentation/drafts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Documentation Drafts

When you create a new feature but for some reason can't create a full fledged documentation pull request, you can create a `draft` with is a single file pull request with critical information needed to create the desired documentation, after creating the draft, the documentation team will edit the pull request to suit the documentation standards.

- [New Feature Draft](new-feature-draft/)
- [Feature Change Draft](feature-change-draft/)
29 changes: 29 additions & 0 deletions contributing/documentation/drafts/feature-change-draft/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Feature Change Documentation Draft Template

If you created a pull request and believe that it could change something already documented, use this template to create a draft for the documentation.

Firstly to check if the feature you are working on is already documented, you can take a look in the documentation map (<https://rocket.chat/docs/contributing/documentation/documentation-map/>), that is a list with all the articles and their current status. Alternatively you can use the search bar on our documentation website (<https://rocket.chat/docs/>).

To submit a draft, create a pull request(make sure you are doing from a branch in the repository) and tag it as 'draft', after that the documentation team will edit it to suit the documentation standard.

The draft serves to give information to the documentation team so they can create the appropriate documentation for that feature.

When a feature is changed, its very important to update the documentation, the lack of this custom can lead to outdated and invalid documentation quickly.

_Note 1: the template is not absolute, and in some cases it might not make sense to follow the template by the letter. If a field can't be answered you can leave it as "N/A"_

_Note 2: sometimes creating a pull request and doing the fix to the docs can be faster than creating a draft (especially in small changes), so don't be afraid to create a pull request directly to change the docs._

```
# FEATURE NAME
**Changed in version:** <!-- The version that feature was changed -->
**Link to original documentation:**
**Link to pull request:**
**What was changed:** <!-- What have change in the feature? -->
**Has the way to use the feature changed?:** <!-- To use that feature, will the user have to do something different than before? -->
```
25 changes: 25 additions & 0 deletions contributing/documentation/drafts/new-feature-draft/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# New Feature Documentation Draft Template

If you have created a pull request creating a new feature please use this template to create a draft of the documentation.

To submit a draft, create a pull request(make sure you are doing from a branch in the repository) and tag it as 'draft', after that the documentation team will edit it to suit the documentation standard.

The draft serves to give information to the documentation team so they can create the appropriate documentation for that feature.

Please try to be very detailed when writing about the feature, this will help create better documentation.

_Note: the template is not absolute, and in some cases it might not make sense to follow the template by the letter. If a field can't be answered you can leave it as "N/A"_

```
# FEATURE NAME
**Added in version:** <!-- The version that feature was implemented -->
**Type of feature:** <!-- What type is the feature being created. E.g. API, User Feature, Admin Feature, Development Feature, etc... -->
**Involved settings:** <!-- Does this features adds or changes any setting? Which ones? What do they do? -->
**Description:** <!-- What does this feature do? -->
**How to use this feature:** <!-- How can this feature be used? -->
```

0 comments on commit f6944ab

Please sign in to comment.