Wilfred Spiegelenburg created YUNIKORN-348:
----------------------------------------------

             Summary: Document how to update documentation after move to 
docusaurus
                 Key: YUNIKORN-348
                 URL: https://issues.apache.org/jira/browse/YUNIKORN-348
             Project: Apache YuniKorn
          Issue Type: Task
          Components: documentation, website
            Reporter: Wilfred Spiegelenburg


The current documentation on how to update the docs, add a new page etc is 
totally lacking. There is no information on the how and what in the current 
readme on the site repo. The current README in the master branch of the site is 
not good enough.

We need to give a step by step instruction on how, where and what:
- part of the website (static doc)
- what can and cannot be updated (only un-versioned doc should be updated or 
added to)
- how to update a page
- image links and asset control
- how to add a new page, what to update, requirements for page content

The current 
[README|https://github.com/apache/incubator-yunikorn-site/tree/master] is by 
now measurement enough.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to