Spread tests for tutorial

[javierdelapuente]

Overview

This PR creates a testable tutorial, in a similar fashion as it is done in rockcraft and charmcraft, using spread and sphinx. For that, it uses two plugins in sphinx, one to parse Markdown and one to build into Markdown, so it should work with discourse.

The tutorial had to be adapted to use env variables instead of just place holders. The scripts used were copied from the project charmcraft.

As src-docs is not used in NetBox (as the code is really in paas-charm), the src-docs directory was reused for it.

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Manging Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated.
• The PR is tagged with appropriate label (urgent, trivial, complex)

[github-actions]

license-eye has checked 1710 files.

Valid	Invalid	Ignored	Fixed
12	7	1691	0

Click to see the invalid file list

• charm/src-docs/Makefile
• charm/src-docs/conf.py
• charm/src-docs/make.bat
• charm/src-docs/tutorial/code/getting-started/task.yaml
• charm/tests/spread/lib/cloud-config.yaml
• charm/tests/spread/lib/test-helpers.sh
• charm/tests/spread/lib/tools/retry

Use this command to fix any missing license headers

```bash

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

</details>

[jdkandersson]

I like the use of markdown instead of rst and it seems that we can include the code anyway so perhaps we use markdown at least in our docs?

[javierdelapuente]

I like the use of markdown instead of rst and it seems that we can include the code anyway so perhaps we use markdown at least in our docs?

I think if everything is displayed correctly in discourse (pending to see), we can use this for all our charms.

[github-actions]

Test coverage for 9deb09f

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py       7      1      2      1    78%   20
----------------------------------------------------------
TOTAL              7      1      2      1    78%

Static code analysis report

Run started:2024-11-29 16:01:42.344688

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 660
  Total lines skipped (#nosec): 1
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

[erinecon]

Thanks for updating the tutorial and adding a spread test! The documentation changes look good to me 👍
(Not giving an official approval since code was also changed in this PR.)