Uploaded image for project: 'Apache YuniKorn'
  1. Apache YuniKorn
  2. YUNIKORN-348

Document how to update documentation after move to docusaurus

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Target Version:

      Description

      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 is by no measurement enough.

        Attachments

          Activity

            People

            • Assignee:
              wilfreds Wilfred Spiegelenburg
              Reporter:
              wilfreds Wilfred Spiegelenburg

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment