stackabletech / stackabletech/documentation

Improve docs authoring experience

Open
#519 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
13
Forks
14
Avg merge
4d 8h
Merged PRs (30d)
10

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:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.