Uploaded image for project: 'Apache Submarine'
  1. Apache Submarine
  2. SUBMARINE-723

[Umbrella] Refactor Submarine documents

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 0.6.0
    • Doc
    • None

    Description

      Goal:

      • Sort documents into three categories (Admin, user, developer)
      • Use https://v2.docusaurus.io/docs/installation to deploy the Submarine website
      • Remove some outdated and empty documents
      • Add more tutorial or example (CTR, SDK, experiment, experiment-template)
      • Improve development documentation (How to debug Submarine server)
      • Improve admin docs (Deploy Submarine in the production environment)

      Preview the website:  https://submarine.apache.org/ 

      Feel free to create a Jira ticket under this umbrella issue.

      Attachments

        1.
        		 Reorganize Submarine Documentation Sub-task Resolved Kevin Su
        2.
        		 Documentation for tensorboard Sub-task Resolved Byron Hsu
        3.
        		 The experiment example will cause OOM error. Sub-task Resolved Kai-Hsun Chen
        4.
        		 Automatically Deploy Submarine Website Sub-task Resolved Kevin Su
        5.
        		 Refactor developer guide Sub-task Resolved Byron Hsu
        6.
        		 Support search bar on Submarine website Sub-task Resolved Wen-Chien,Juan
        7.
        		 Update Submarine python SDK documentation Sub-task Resolved Kevin Su
        8.
        		 Update notebook documentation Sub-task Resolved KUAN-HSUN-LI
        9.
        		 Update Contributing guide Sub-task Resolved Kai-Hsun Chen
        10.
        		 Many Links in README.md are not working Sub-task Resolved Yuan-Chia, Chang
        11.
        		 Replace port 8080 with port 32080 in API example Sub-task Resolved Jhan-Shuo Liu
        12.
        		 Upload NTU workshop video Sub-task Resolved Liang-Chun, Chen
        13.
        		 Update adminDocs directory structure Sub-task Resolved Kai-Hsun Chen
        14.
        		 Update devDocs directory structure Sub-task Resolved Kevin Su
        15.
        		 Add develop submarine website guide Sub-task Resolved Kevin Su
        16.
        		 [User] Refactor User docs Sub-task Resolved Byron Hsu
        17.
        		 [User] API documentation Sub-task Resolved Jhan-Shuo Liu
        18.
        		 [User] Python SDK Model Client Sub-task Resolved Liang-Chun, Chen
        19.
        		 [User] Python SDK Experiment Client and Tracking Sub-task Resolved Jhan-Shuo Liu
        20.
        		 [User] Other utilities Sub-task Resolved Yuan-Chia, Chang
        21.
        		 [Quickstart] Rewrite quickstart guide Sub-task Resolved Byron Hsu
        22.
        		 Add KinD deploy tutorial under prerequisite Sub-task Resolved KUAN-HSUN-LI
        23.
        		 Update github readme Sub-task Resolved Kevin Su
        24.
        		 [Dev] Update test-k8s in integration test Sub-task Resolved KUAN-HSUN-LI
        25.
        		 Update README of submarine-cloud-v2 and add developer guide Sub-task Resolved Chi-Sheng Liu
        26.
        		 [Dev] Add operator docs to devDocs Sub-task Resolved Chi-Sheng Liu
        27.
        		 [Dev] Update Overview in Development Guide Sub-task Resolved Che-Kuang Chu
        28.
        		 Add README to submarine-cloud-v2/hack Sub-task Resolved Che-Kuang Chu
        29.
        		 Add README to submarine-cloud-v2/artifacts/examples Sub-task Resolved You Ting Wang
        30.
        		 [Dev] Update test-e2e in integration test Sub-task Resolved You Ting Wang
        31.
        		 [User] Modify user documentation Sub-task Resolved Byron Hsu
        32.
        		 Improve submarine-cloud-v2 documents Sub-task Resolved Kai-Hsun Chen
        33.
        		 Improve documents about submarine-operator and integration tests Sub-task Resolved Kai-Hsun Chen

        Activity

          People

            pingsutw Kevin Su
            pingsutw Kevin Su
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: