canonical / canonical/sphinx-stack

First impressions (again)

Open
#385 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
37
Forks
77
Avg merge
1d 5h
Merged PRs (30d)
3

Description

- [ ] quick start
- [ ] prerequisites
- [ ] upgrading from the old thing
- [ ] upgrading from earlier version
- [ ] initial setup
- [ ] spread tests
- [ ] customisations
- [ ] pre-commit spelling
- [ ] pre-commit woke

## Quick Start

The docs for the docs pack need a quick start page.

Today, `git clone; cd shpinx-docs-starter-pack/docs; make run; open http://127.0.0.1:8000/tutorial/set-up/` kindof serves as that, but it's not focused.

## Upgrading from the old thing

http://127.0.0.1:8000/how-to/migrate-from-pre-extension/ is great, but how do I know if the current project setup is pre-extension or post-extension? I've been dropped into an existing project, someone else had set docs back in the day.

## Upgrading from an earlier version

How do I know if my project config / extension is up to date?

How do I upgrade if it's not?

## Initial setup

Copy all... including `.wokeignore (configuration for the Woke tool)` -- there's no such file

## Spread tests

http://127.0.0.1:8000/tutorial/set-up-automated-testing/ speaks of Spread tests.

Spread is great... but... why do I need this? When would I need it? Is this testing my project, my project docs or the started pack?

## Customisations

http://127.0.0.1:8000/how-to/customise/ explains how to customise. I'm dropped into a project, how do I know what has already been customised? How do I avoid overwriting deliberate changes?

## Prerequisites

Today https://canonical-starter-pack.readthedocs-hosted.com/latest/how-to/contributing/#environment-setup reads:
```
Environment setup
To work on the project, you need the following prerequisites:

[TODO: Prerequisite 1](http://example.com/)

[TODO: Prerequisite 2](http://example.com/)
```

## pre-commit spelling

Fails on macOS with:

```
make: nproc: Command not found
. .sphinx/venv/bin/activate ; python3 -m pyspelling -c .sphinx/spellingcheck.yaml -j
usage: pyspelling
[-h]
[--version]
[--verbose]
[--name NAME | --group GROUP]
[--binary BINARY]
[--jobs JOBS]
[--config CONFIG]
[--source SOURCE]
[--spellchecker SPELLCHECKER]
pyspelling: error: argument --jobs/-j: expected one argument
make: *** [spellcheck] Error 2
```

## pre-commit woke

fails with

```

reference/style-guide-myst.md
2:133 error Replace 'master' with an Canonical.400-Enforce-inclusive-terms
inclusive term

✖ 1 error, 0 warnings and 0 suggestions in 27 files.
make: *** [woke] Error 1
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.