Versions Compared

Old Version 22

changes.mady.by.user Cassandra Targett

Saved on

compared with

New Version Current

changes.mady.by.user Cassandra Targett

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Mark some todo items as done

...

  1. Because it's Git-based, once we have it all set up it will by default only build from the files checked into the origin repo in Git. This makes it a little bit harder to build locally, although there is a local "author" mode available. 
  2. I'm not clear if Jenkins (ci-builds) will be able to build this. I found another Apache project (Aries) that uses Antora and builds with Jenkins, but I'm unclear how they really set it up (their job is here). We may need a conversation with ASF Infra on this edit 24 Nov: I set up a Jenkins job to test this out and it works seamlessly: https://ci-builds.apache.org/job/Solr/job/solr-reference-guide-antora/. It's currently run on demand only, and pushes the output to the nightlies.apache.org server.
  3. Validation that Gradle plugin is viable (using this may just solve the Jenkins question)

...

  1. If we don't want to put the UI into a separate repo, we could publish to nightlies.apache.org, like we do with the Lucene snapshot.
    1. edit 24 Nov: To test this out I built the current UI from the branch locally and pushed it up to nightlies.apache.org, at https://nightlies.apache.org/solr/draft-guides/ui-bundle.zip. The playbook.yml file in the branch has been updated to pull from this location. To me this feels like the right way to do this, but it should probably have a Jenkins job and be versioned once the dust settles.
  2. We could also commit the .zip to the solr  repo, but that also feels like something we don't really like to do (or I could be wrong?). And it could drift by branch....
  3. Or we could have a separate repo for the UI files that has "releases" stored in Github? This has felt rather heavy to me.

...

  • Finish the UI updates
    • Styling, header, footer
    • DRAFT watermark and styling
    • Add STEM support (do-able, just not done)
  • Write an Antora extension to do validation like orphan checking (maybe also other things? could be added later)
  • Figure out how we will populate variables like dependency versions we get from versions.lock  today, and other things today we automatically populate like the version in the header, etc. I wonder if Antora's new extensions could do this?
  • Fix how all inter-page links are constructed (from << >>  to xref:  ) to be sure inter-module links are correct - DONE 12/2021
  • Remove pages that are primarily navigational which today make our hierarchy look duplicated. - DONE 12/2021
  • Since 9.0 will have new page names and this change will create new URL paths, we probably really should do something about redirecting old pages

...