docs(docusaurus): freeze v1.9.0 documentation snapshot and fix local dev build (#60)

Signed-off-by: Debjeet Banerjee <debjeetbanerjee48@gmail.com>
Co-authored-by: Lucas Amaral <lucaaamaral@gmail.com>

Author: mintRaven-05

Makefile

@@ -9,7 +9,7 @@ precommit:  ## Run docs precommit checks
 precommit_fix:  ## Try to fix existing precommit issues
 	make -C readmes precommit_fix
 
-sidebar_check:  ## Check if all pages are implemented with sidebars for 1.7.0, 1.8.0, and latest
+sidebar_check:  ## Check if all pages are implemented with sidebars
 	python3 check_sidebars.py
 
 # Ref: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

check_sidebars.py

@@ -136,7 +136,7 @@ def main():
     """
     Check if all pages are implemented in the sidebar.
     """
-    versions = ("latest", "1.8.0", "1.7.0")
+    versions = ("latest", "1.9.0", "1.8.0", "1.7.0")
     pages_not_implemented = {v: set() for v in versions}
     for v in versions:
         all_pages = get_all_pages(version=v)

docusaurus/create_docusaurus_website.sh

@@ -15,7 +15,7 @@ set -e
 
 function exit_timeout() {
   echo ''
-  docker compose logs docusaurus
+  docker compose logs dev
   echo ''
   echo "Timed out after ${1}s waiting for Docusaurus container to build. See logs above for more info."
   echo "Possible remedies:"
@@ -39,8 +39,8 @@ function spin() {
 }
 
 docker compose down
-docker build -t magma_docusaurus .
-docker compose --compatibility up -d
+docker compose build dev
+docker compose up -d dev
 
 echo ''
 echo 'NOTE: README changes will live-reload. Sidebar changes require re-running this script.'
@@ -50,4 +50,4 @@ echo 'If you want to follow the build logs, run docker compose logs -f docusauru
 spin
 echo 'Navigate to http://localhost:3000/ to see the docs.'
 
-# xdg-open 'http://localhost:3000/docs/next/basics/introduction.html' || true
+xdg-open 'http://localhost:3000/docs/next/basics/introduction.html' || true

docusaurus/package.json

@@ -1,6 +1,6 @@
 {
   "name": "magma-documentation",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

docusaurus/versioned_docs/version-1.9.0/.markdownlint.yaml

@@ -0,0 +1,207 @@
+# Source: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+# Ref: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+
+# Default state for all rules
+default: true
+
+# MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time
+MD001: true
+
+# MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading
+MD002:
+  # Heading level
+  level: 1
+
+# MD003/heading-style/header-style - Heading style
+MD003:
+  # Heading style
+  style: "atx"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  # List style
+  style: "dash"
+
+# MD005/list-indent - Inconsistent indentation for list items at the same level
+MD005: true
+
+# MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line
+MD006: true
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4
+  # Whether to indent the first level of the list
+  start_indented: false
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+MD010:
+  # Include code blocks
+  code_blocks: false
+
+# MD011/no-reversed-links - Reversed link syntax
+MD011: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+
+# MD013/line-length - Line length
+MD013:
+  # Disable line-length checks
+  line_length: -1
+
+# MD014/commands-show-output - Dollar signs used before commands without showing output
+MD014: true
+
+# MD018/no-missing-space-atx - No space after hash on atx style heading
+MD018: true
+
+# MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading
+MD019: true
+
+# MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading
+MD020: true
+
+# MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading
+MD021: true
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line
+MD023: true
+
+# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024:
+  # Only check sibling headings
+  allow_different_nesting: true
+  # Only check sibling headings
+  siblings_only: true
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+MD025:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: ""
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
+MD027: true
+
+# MD028/no-blanks-blockquote - Blank line inside blockquote
+MD028: true
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines
+MD031:
+  # Include list items
+  list_items: true
+
+# MD032/blanks-around-lists - Lists should be surrounded by blank lines
+MD032: true
+
+# MD033/no-inline-html - Inline HTML
+MD033:
+  # Allowed elements
+  allowed_elements: []
+
+# MD034/no-bare-urls - Bare URL used
+MD034: true
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "---"
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
+MD036:
+  # Punctuation characters
+  punctuation: ".,;:!?。，；：！？"
+
+# MD037/no-space-in-emphasis - Spaces inside emphasis markers
+MD037: true
+
+# MD038/no-space-in-code - Spaces inside code span elements
+MD038: true
+
+# MD039/no-space-in-links - Spaces inside link text
+MD039: true
+
+# MD040/fenced-code-language - Fenced code blocks should have a language specified
+MD040: true
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: ""
+
+# MD042/no-empty-links - No empty links
+MD042: true
+
+## MD043/required-headings/required-headers - Required heading structure
+#MD043:
+#  # List of headings
+#  headings: []
+#  # List of headings
+#  headers: []
+
+# MD044/proper-names - Proper names should have the correct capitalization
+MD044:
+  # List of proper names
+  names: []
+  # Include code blocks
+  code_blocks: true
+
+# MD045/no-alt-text - Images should have alternate text (alt text)
+MD045: true
+
+# MD046/code-block-style - Code block style
+MD046:
+  # Block style
+  style: "consistent"
+
+# MD047/single-trailing-newline - Files should end with a single newline character
+MD047: true
+
+# MD048/code-fence-style - Code fence style
+MD048:
+  # Code fence syle
+  style: "backtick"

docusaurus/versioned_docs/version-1.9.0/Dockerfile

@@ -0,0 +1,17 @@
+# Copyright 2023 The Magma Authors.
+
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM node:20.16
+
+RUN mkdir -p /readmes
+WORKDIR /readmes
+
+RUN npm install --global markdownlint-cli

docusaurus/versioned_docs/version-1.9.0/Makefile

@@ -0,0 +1,14 @@
+.PHONY: precommit precommit_fix
+
+FILES_TO_IGNORE = --ignore proposals/p010_vendor_neutral_dp.md \
+                  --ignore proposals/p010_subscriber_scaling.md \
+                  --ignore proposals/p015_tech_debt_week.md \
+                  --ignore proposals/p018_control_network_metrics.md
+
+precommit:
+	docker build -t magma_readmes .
+	docker compose --compatibility run readmes markdownlint $(FILES_TO_IGNORE) . && echo PASSED
+
+precommit_fix:
+	docker build -t magma_readmes .
+	docker compose --compatibility run readmes markdownlint --fix $(FILES_TO_IGNORE) . && echo PASSED