Uploaded image for project: 'Cassandra'
  1. Cassandra
  2. CASSANDRA-16763

Create Cassandra documentation content for new website

Log workAgile BoardRank to TopRank to BottomAttach filesAttach ScreenshotBulk Copy AttachmentsBulk Move AttachmentsVotersWatch issueWatchersCreate sub-taskConvert to sub-taskMoveLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Operability
    • Normal
    • All
    • None
    • Hide

      The Cassandra documentation can be rendered using the tooling in the cassandra-website repository. The steps to do this are as follows.

       

      Step 1. Set up the cassandra-website tooling

      Clone the cassandra-website to your local machine by running the following command.

      $ git clone https://github.com/apache/cassandra-website.git

      Build the ui-bundle.zip to style the documentation by running the following command.

      $ ./run.sh website-ui bundle 

      The ui-bundle.zip file will be located in site-ui/build/

       

      Step 2. Render the documentation

      Render the website and documentation HTML for the latest three branches of Cassandra using the following command.

      $ ./run.sh website build \
          -i
          -z site-ui/build/ui-bundle.zip \
          -u cassandra:https://github.com/polandll/cassandra.git

      The rendered HTML will be located in site-content/build/html/

      To view the documentation open a browser and navigate to file:///<path_to_cassandra_website>/site-content/build/html/Cassandra/

      Show
      The Cassandra documentation can be rendered using the tooling in the cassandra-website repository. The steps to do this are as follows.   Step 1. Set up the cassandra-website tooling Clone the cassandra-website to your local machine by running the following command. $ git clone https: //github.com/apache/cassandra-website.git Build the ui-bundle.zip to style the documentation by running the following command. $ ./run.sh website-ui bundle The ui-bundle.zip file will be located in site-ui/build/   Step 2. Render the documentation Render the website and documentation HTML for the latest three branches of Cassandra using the following command. $ ./run.sh website build \ -i -z site-ui/build/ui-bundle.zip \ -u cassandra:https: //github.com/polandll/cassandra.git The rendered HTML will be located in site-content/build/html/ To view the documentation open a browser and navigate to file:/// <path_to_cassandra_website>/site-content/build/html/Cassandra /

    Description

      We need create the content (asciidoc) to render the Cassandra documentation using Antora. This work can commence once the following has happened:

      Attachments

        Issue Links

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            mck Michael Semb Wever Assign to me
            Anthony Grasso Anthony Grasso
            Michael Semb Wever
            Michael Semb Wever
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - Not Specified
              Not Specified
              Remaining:
              Remaining Estimate - 0h
              0h
              Logged:
              Time Spent - 4h 40m
              4h 40m

              Slack

                Issue deployment