tl;dr  Can we switch the website over to a temporary static-html
version of the new design, while work on the final antora generated
version continues?
https://cassandra.staged.apache.org/


In February a preview of the new website was announced¹. Melissa Logan
and co have been working hard at getting this ready, and it's looking
amazing!² There is a lot of excitement in getting this design out for
the world party next week. Because the work on the antora build for
the website is still ongoing, a temporary static-html version of the
new website has been prepared so we can go live with the design
without being blocked on the antora work. The antora work associated
with the new design is the build generation tooling that Anthony
Grasso has been hammering away on. There is also the rewrite of the
in-tree documentation content from rst to asciidoc³ that Lorina Poland
has the mammoth task of, but as can be seen from the new design at
cassandra.staged.apache.org this work is intended to land later on
anyway.

Pushing out the static-html website comes with the following consequences
 - it commits us to the antora version
 - it prevents updates to the website until the antora version is finished

This raises the following questions
  A. How long will the static html version be there for?
  B. How impeded will we be during that period?
  C. What will the eventual antora version look like? how will it be
used? will it be easy and intuitive?


I can't answer all these questions, so I hope others can help. But my input is…

B) Simple edits to existing pages will be easy, updating the downloads
page will be possible but a bit clumsy and time-consuming, while
adding blogs and new content will be too much work for value.

C) The antora website generation is ready for early review, ref CASSANDRA-16066
Anthony did a lot of work on the past website in dockerising the build
to make it easier and more reliable. This has been repeated on the new
website and its brand new antora build scripts, for example there's a
`run.sh` script to provide a porcelain api for the typical builds
operations required. The website consists of a top-level website (the
cassandra-website repo), its UI, multiple versions of Cassandra docs
(the docs/ folder in the cassandra repo) which consists of the cql
docs and the nodetool generated docs. It's not the simplest of
websites, full builds can take some time because of it, but Anthony
has provided a number of examples in the ticket to show how to
undertake the different builds you'll typically need. And it's all
prepared to plug into ci-cassandra.a.o so it will be CD to
cassandra.staged.a.o.  If you would like to give it a whirl see this
jira comment that goes through the examples:
https://issues.apache.org/jira/browse/CASSANDRA-16066?page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel&focusedCommentId=17326637#comment-17326637

regards,
Mick


[1] 
https://lists.apache.org/thread.html/rf2b5b7710033350dba5b0ab2e71da03111da28357f96df585b96a708%40%3Cdev.cassandra.apache.org%3E
[2] https://cassandra.staged.apache.org/
[3] 
https://lists.apache.org/thread.html/r42802f86d7893c42b5091fe7f7d4b048a63cbe0fd11fadcd120596e3%40%3Cdev.cassandra.apache.org%3E

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@cassandra.apache.org
For additional commands, e-mail: dev-h...@cassandra.apache.org

Reply via email to