perfsonar / perfsonar/docs

Make repo URLs easier to maintain

Open
#197 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs.perfsonar.net enhancement
Dominant language
Python
Stars
5
Forks
7
Avg merge
1m
Merged PRs (30d)
1

Description

It would be easier to maintain repo URLs etc in the docs if we had global variables that we could use for them. This way when we move from beta to final, for instance, we don't have to update the URL to the repo in a whole bunch of docs -- just one variable change.

It might also be useful to do this for the repo RPMs to make it easier to add the latest repo.

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

No files or tests are named; start by inspecting the documentation structure and locating repeated repository and RPM URLs. Determine how shared values can be maintained in the documentation workflow, then verify that changing each value updates all affected rendered links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.