Commit Graph

4 Commits

Author SHA1 Message Date
Sean Mooney 33a56781f4 fix sphinx-lint errors in docs and add ci
This change mainly fixes incorrect use of backticks
but also adress some other minor issues like unbalanced
backticks, incorrect spacing or missing _ in links.

This change add a tox target to run sphinx-lint
as well as adding it to the relevent tox envs to enforce
it in ci. pre-commit is leveraged to install and execute
sphinx-lint but it does not reqiure you to install the
hooks locally into your working dir.

Change-Id: Ib97b35c9014bc31876003cef4362c47a8a3a4e0e
2024-04-17 13:33:47 +01:00
Elod Illes 23c345d61d Update serial console example client for py3
A very limited and minimal serial console example client code exists
in the documentation [1] for testing purposes. This code was not
updated to python 3. This patch updates the example code to be python3
compatible.

[1] https://docs.openstack.org/nova/latest/contributor/testing/serial-console.html#testing-the-api

Closes-Bug: #2009956
Change-Id: If6617f169d1221b4c43938bdfd37207d079cc7da
2023-03-21 15:30:40 +01:00
zhufl 84afd12589 Change some URLs to point to better targets
This is to change some URLs to point to better or more accurate targets.

Change-Id: I1d450ba8bd2271a69f9380cc4d2b36ae3eefe09a
2019-05-13 00:52:23 +00:00
Stephen Finucane a2165cf651 doc: Populate the 'contributor' section
Per the spec [1]:

  contributor/ – anything related to contributing to the project or how
  the team is managed. Applies to some of the current content under
  /developer, we are changing the name to emphasize that not all
  contributors are developers and sometimes developers are users but not
  contributors.

We currently have a handful of docs that focus on the "how to develop or
contribute" aspects of nova, and these are moved. Docs that focus on
architecture or design decisions for nova are not moved, as these will
go into 'reference'.

A TODO is added to the former 'api_plugins' document as it's mega
out-of-date and needs some serious work.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: Iad770688b4eafeb9caa710b4398b02d80a017a70
2017-07-18 15:41:19 +01:00