CASSANDRA-16066 Create tooling and update repository layout to render new website #68
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Updated site.yaml generator script to retrieve release version information from downloads page * Updated site.template.yaml to be populated with release version information * Updated download content to specify correct download links
…ilding site-ui and website
* Updated Docker build time arguments to contain a postifx '_ARG' * Added preview mode to render entire website using Antora * Trimmed back docker-compose file as it will be phased out * Started reworking README file
…nerated ADOC files to Cassandra repository. Added ability to only have a single content source for the site.yaml file
…assandra-website as a source unless the generate-docs command is supplied. In which case the cassandra website is used as a source as well.
* Added default cassandra-website location and branch when building or previewing the site * Removed debug output * Updated comments
…branches and tags were never converted to space dilimited list that is passed to Docker
* Fixed bug that caused website Docker container to exit if no changes were detected when committing generated docs * Moved the cloning of the Cassandra repository from the creation of the container and made it an on-demand action in the docker-entrypoint.sh * Removed the option to specify a Cassandra repository argument when building container * Added option to include Cassandra repository as an Antora source without needing to generate the AsciiDocs * Changed the cassandra-website default branch from trunk to HEAD
* Added option to include Cassandra repository as a source without generating the AsciiDocs * Added logic to add locally mapped cassandra-website as the website source if no URL is provided to a cassandra-website repository * Updated help message output for various options
* Added logic to check if Docker is running * Added logic to check if local Cassandra repository path has been specified when only generating the AsciiDocs (i.e. only using 'docs' command)
* Fixed bug in regex where a word in the version number e.g. 'rc' was failing to be detected * Fixed bug so latest Cassandra version is added to version list as 'latest' as well as its version number. This prevents the script failing if version number is listed in the template
* Updated website Dockerfile to install asciidoctor-openblock * Updated site.template.yaml to include asciidoctor-openblock so Antora uses it when rendering the site
* The adoc 'modules' directory will no longer be nested in 'cassandra/doc/source/'. Instead it will be 'cassandra/doc/'. That is 'modules' directory has been moved up one directory level.
* Added logic to get website container build directory to use when creating volume mappings
* Added the option to specify the build user as an argument when building the container
* Move website docker container files from repository root to the 'site-content' directory
* Updated website container build command to use new website Dockerfile location
* Corrected example command arguments when using the run script to build the website container * Updated the example command when using the run script to build the website container so it shows how the username of the build user can be changed
* Updated the path to the website docker contain to reflect its new location
* Fixed issue where default build user is always displayed as being configured even when a different user is specified as the build user.
* Fixed bug where owner and permissions set on files (e.g. ui-bundle.zip) generated by container are set to root user. * Added logic to configure and set up a build user to run as when generating files in container. * Added ability to override default build user name and permissions when building the container
* Changed the usage format of the script so that optional arguments must be supplied after the <component> and the <command> * Refactored the container build functions into a single one as both have almost idential logic * Added a function to get the build directory of a container so local paths can be mapped to the correct internal container paths when calling each of the containers * Added a run docker UI command function so that UI commands operate in a similar way to the website commands
* Added information about run.sh usage format * Added information on how to supply the path/URL to a ui-bundle.zip file when rendering the website * Added information about customising the permissions of the UI website container when it is built * Updated the ordering of the ./run.sh commands to reflect the change to the usage format
* Fixed bug where build arguments are never correctly passed to Docker when running ./run.sh on Mac OS X
* Implemented full 'file' URI parsing * Fixed issue where relative path always had to start with './'; allows start of path to be just a directory name
* Changed default values for container environment variables ANTORA_SITE_URL and ANTORA_SITE_START_PAGE
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.