Improve docs authoring experience
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation, tooling
Research direction
Start by reviewing the Antora Atlas extension and the partial build extension linked in the issue, then examine the current documentation build workflow. Define how UI bundle caching and partial builds would affect the two-repository setup; done means a documented, working authoring workflow with shorter build times.
Written by the indexing model from the issue text.
Description
As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.
Currently the workflow is:
- checkout both the docs repo and the operator repo
- edit the playbook file to point to the local operator repo checkout
- write the docs in the operator repo and rebuild the docs periodically
Main pain points are:
- the setup is cumbersome
- build times are long
### Tasks
- [ ] Cache UI bundle in the build
- [ ] investigate Atlas/partial build extension
Links:
- Antora Atlas extension: https://gitlab.com/antora/antora-atlas-extension
- partial build extension: https://github.com/spring-io/antora-extensions#partial-build (depends on the Atlas extension)
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stackabletech/documentation
-
Withdraw ADR018 Open
Difficulty 1/5 Under an hour Newbie friendliness 68/100
stackabletech/documentation#734 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
stackabletech/documentation#779 ·
-
customer-request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stackabletech/documentation#773 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
stackabletech/documentation#754 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
stackabletech/documentation#753 ·
All issues in stackabletech/documentation
Similar issues
-
triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
feature pydanty:is-working
Difficulty 1/5 Under an hour Newbie friendliness 88/100
pydantic/pydantic-ai#8647 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100