Vanilla Docs!!

Unknown
Unknown
in General

As Vanilla grows we need docs to be created and updated more frequently. These requests come  in through Support, or Slack, and gaps in information are often just uncovered in passing.


As this is a team-effort, and we are all responsible for the creation and upkeep of customer-facing docs,  various team members across several departments will need to be involved in their creation and upkeep, but it is important to note, that we’ve created a new Github repo dedicated to Vanilla Cloud documentation requests -  https://github.com/vanilla/cloud-docs

This will allow us to centralize and keep track of internal staff docs and external customer-facing  docs, as well as collaborate across the organization. 


You can create a new issue here:  https://github.com/vanilla/cloud-docs/issues/new/choose`


Write up what your intended change or creation in the github review and assign to a subject matter expert for review.


By default, issues will be assigned to Shauna, she will do her best to help you if - 

  • you are not sure if an update is appropriate
  • you are unsure about the subject matter, or who the subject matter expert may be
  • you would like to create a brand new doc


If you have suggestions on what to fix/add and would just like it to be reviewed, include your proposed change or addition.


What doesn't need to go in this repo:

-items that don't need to be reviewed by another staff member (i..e, you are the subject matter expert)

-typos

-grammar fixes


Typos etc can quickly be edited and fixed directly in KB. If you do not have access to edit articles, reach out on Slack and someone can assist you. 

Comments

Categories