////
Copyright (c) 2024 The C++ Alliance, Inc. (https://cppalliance.org)

Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Official repository: https://github.com/boostorg/website-v2-docs
////
= Appendix I - Organization Guide
:navtitle: 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>>
* <<Website Operations>>
* <<Doc Builds>>
* <<Boost Release Reports>>

== Server Hosting

Provides details on the staging and production processes.

[cols="1,4",options="header",stripes=even,frame=none]
|===
| *Document Link* | *Description* 
| https://github.com/cppalliance/website-v2-operations/blob/master/deployments/README.md[Deployments] | 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.
| https://github.com/cppalliance/website-v2-operations/blob/master/gcp/README.md[GCP Notes] | 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.
| https://github.com/cppalliance/website-v2-operations/blob/master/aws/README.md[Amazon AWS Notes] |  In the *us-east-2* region AWS S3 buckets store the described content.
| https://github.com/cppalliance/website-v2-operations/blob/master/fastly/README.md[Fastly Notes] | A Fastly CDN is configured as a front-end to the stage and production sites. This document describes the configuration steps.
| https://github.com/cppalliance/website-v2-operations/blob/master/mailman/README.md[Mailman Notes] |Mailman-core servers have been installed to test a selection of REST API calls.
| https://github.com/cppalliance/website-v2-operations/blob/master/website/README.md[Website Admin] | Contains some notes on staging synchronization.
|===

== Website Operations

Provides operational details, specifically for each release.

[cols="1,4",options="header",stripes=even,frame=none]
|===
| *Document Link* | *Description* 
| https://github.com/cppalliance/jenkins-ci/blob/master/docs/user-guide.md[Documentation and Website Previews for The C++ Alliance] | This section covers what contributors should know about the preview generation on https://github.com/CPPAlliance/cppalliance.github.io[cppalliance.github.io] and other github repositories.
| https://github.com/cppalliance/jenkins-ci/blob/master/docs/jenkins-summary.md[Jenkins Summary] | 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.
| https://github.com/cppalliance/jenkins-ci/blob/master/docs/jenkins-details.md[Jenkins System and Job Information] | This section goes into exhaustive detail on Jenkins output that can be used as a reference for any job.
| https://github.com/cppalliance/jenkins-ci/blob/master/docs/inventory.md[Job Inventory] | The current Jenkins job inventory.
| https://github.com/cppalliance/server-docs/tree/master/drone[Drone Docs] | Provides operational details on the CPPAlliance Drone CI implementation.
| https://github.com/cppalliance/server-docs/blob/master/website-redirects/redirects.md[Website Redirects] | There are four subdomains which redirect to https://cppalliance.org/[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 xref:user-guide:ROOT:index.adoc[] and xref:formal-reviews:ROOT:index.adoc[].
. *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 https://github.com/cppalliance/website-v2-operations/tree/master/doc_builds#boost-docs-on-the-website[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: https://downloads.cppalliance.org/reports/boost_1_87_0_release_report.pdf[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!

== See Also

* xref:superproject/overview.adoc[]
* xref:oversight-committee.adoc[]