- change typos in rst components

.gitignore

@@ -1,30 +1,26 @@
-*.DS_Store
-*.egg*
-*.log
-*.mo
+_build/
+/AUTHORS
+/ChangeLog
+/dist/
+/otcdocstheme.egg-info/
+.DS_Store
 *.pyc
-*.swo
-*.swp
-*~
-AUTHORS
-octavia_proxy-*/
-.coverage
-.idea
-.stestr/
-.testrepository
-.tox
-build
-ChangeLog
-dist
-# Doc related
 doc/build
+doc/source/BBresult
 api-ref/build
-# Development environment files
-.project
-.pydevproject
-cover
+.tox
+/.venv
+*.swp
+*.log
+*.egg*
+
+# Editors
+*~
+
 # Files created by releasenotes build
 releasenotes/build
-.ropeproject
-test.py
-.vscode
+
+# Files created by the LaTeX/PDF build
+/.aux
+/.fdb_latexmk
+/texput.fls

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 9136088a246768144165fcc3ecc3d31bb686920a # v3.3.0
+    hooks:
+      - id: trailing-whitespace
+      # Replaces or checks mixed line ending
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      # Forbid files which have a UTF-8 byte-order marker
+      - id: check-byte-order-marker
+      # Checks that non-binary executables have a proper shebang
+      - id: check-executables-have-shebangs
+      # Check for files that contain merge conflict strings.
+      - id: check-merge-conflict
+      # Check for debugger imports and py37+ breakpoint()
+      # calls in python source
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: local
+    hooks:
+      - id: flake8
+        name: flake8
+        additional_dependencies:
+          - hacking>=3.0.1,<3.1.0
+        language: python
+        entry: flake8
+        files: '^.*\.py$'
+        exclude: '^(doc|releasenotes|tools)/.*$'

.zuul.yaml

@@ -0,0 +1,8 @@
+- project:
+    merge-mode: squash-merge
+    default-branch: main
+    vars:
+      # publish to blueprints container
+      container: "blueprints"
+    templates:
+      - publish-otc-docs-hc-pti

bindep.txt

@@ -1 +1,5 @@
+libffi-dev [platform:dpkg]
+libffi-devel [platform:rpm]
+libssl-dev [platform:dpkg]
+openssl-devel [platform:rpm]
 graphviz [doc]

doc/best-practice/source/index.rst

@@ -1,8 +0,0 @@
-==========================================
-Welcome to the documentation of Blueprints
-==========================================
-
-.. toctree::
-   :maxdepth: 1
-
-   cce_vault

doc/requirements.txt

@@ -1,10 +1,12 @@
-sphinx>=2.0.0,!=2.1.0 # BSD
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+# Notes:
+# reno needs openstackdocstheme which needs reno (cycle dep).
+# os-api-ref needs openstackdocstheme which needs os-api-ref (cycle dep).
+# Put them in here will make it clear that those are only needed for
+# docs.
 
-otcdocstheme # Apache-2.0
-
-# releasenotes
+sphinx==4.0.0
+otcdocstheme
 reno>=3.1.0 # Apache-2.0
-
-otc-sphinx-directives>=0.1.0
-sphinx-minify>=0.0.1 # Apache-2.0
-git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata