Skip to content

Commit

Permalink
Organization Guide added (#354)
Browse files Browse the repository at this point in the history
* Organization Guide added as CG appendix

* Organization Guide table entry fixed

* Operation Guide appendix feedback
  • Loading branch information
PeterTurcan authored Oct 22, 2024
1 parent 89d536d commit 7f7eefa
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
3 changes: 3 additions & 0 deletions contributor-guide/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,6 @@ Official repository: https://github.com/boostorg/website-v2-docs
** xref:contributor-community-introduction.adoc[]
** xref:tweeting.adoc[]
** xref:site-docs-style-guide.adoc[]
* Appendices
** xref:organization-guide.adoc[]
46 changes: 46 additions & 0 deletions contributor-guide/modules/ROOT/pages/organization-guide.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
////
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

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.
|===

== See Also

* xref:superproject/overview.adoc[]

0 comments on commit 7f7eefa

Please sign in to comment.