Appendix I - Organization Guide
The information in this appendix is only pertinent to those contributors who are involved with the server hosting, operations and infrastructure for the Website v2. The sections contains links to the eclectic set of documentation maintained on GitHub which provides the detailed implementation notes required by developers and system administrators for the website.
Server Hosting
Provides details on the staging and production processes.
| Document Link | Description |
|---|---|
If you are involved in testing the Boost website-v2, you might not need a full cloud deployment. This document describes potentially more convenient options, including using a local Docker composition, the existing staging site, or the existing production site. If you are involved in the C++ Alliance’s development efforts, code may be checked in directly to the staging and production sites, so another site isn’t needed. |
|
The website is hosted on Google Cloud Platform in a project named "boostorg-project1" within a CPPAlliance account. This document describes the Kubernetes cluster running in the us-central1 region, the Memorystore instance for each environment, and Archive Registry of the Docker images for each website release. |
|
In the us-east-2 region AWS S3 buckets store the described content. |
|
A Fastly CDN is configured as a front-end to the stage and production sites. This document describes the configuration steps. |
|
Mailman-core servers have been installed to test a selection of REST API calls. |
|
Contains some notes on staging synchronization. |
Website Operations
Provides operational details, specifically for each release.
| Document Link | Description |
|---|---|
This section covers what contributors should know about the preview generation on cppalliance.github.io and other github repositories. |
|
Provides notes on the operation of Jenkins. A Jenkins build server is hosted on AWS at https://jenkins.cppalliance.org:8443. The server builds and publishes previews of the documentation for a number of GitHub repositories when pull requests are submitted. |
|
This section goes into exhaustive detail on Jenkins output that can be used as a reference for any job. |
|
The current Jenkins job inventory. |
|
Provides operational details on the CPPAlliance Drone CI implementation. |
|
There are four subdomains which redirect to The C++ Alliance. The redirects act as shortcuts to quickly reach the Slack invitations page, or the main homepage. This section provides implementation details. |
Doc Builds
There a two main areas of documentation that are built for this website:
-
Antora Docs on the website : including this Contributor Guide, along with the User Guide and Introduction to Boost Formal Reviews.
-
Boost Docs on the website : covering the documentation for each individual library.
In addition to these there are also Boost Archives created by Python scripts, and automated Doc Previews that are built by Jenkins.
These build processes are outlined in Doc Builds, which includes links to more details of the build processes.
Boost Release Reports
The purpose of a Boost Release Report is to inspire and credit all of the volunteer contributors who put the work in for the release. A significant audience for the report are these contributors. It is a "feel-good" document by design.
The introductory text for each release will depend on the priorities and new content for the release. For example, refer to: Boost 1.87 Release Report.
Leave it to the technical documentation for each library, tool or process to go into such things as limitations, known issues, performance considerations, and so on.
Write this report in such a way as to inspire our contributors to re-engage for a future release!