uabrc / uabrc/uabrc.github.io

Repeated information in Docs

Open
#878 0 comments 0 reactions 1 assignee View on GitHub

@iam4tune is already working on this.

Since Dec 20, 2024.

fix: inaccuracy ⚠️
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

What is inaccurate?

We have content in our documentation that contains the same or similar information repeated in sometimes two or more locations. This duplicate content can cause a confusion on what instruction our users should follow, as one section may be up to date, and the other(s) may contain obsolete information.

We can fix this by identifying sections that have this duplicate information and then restructuring the content to include crosslinks. My suggestion would be to leave the actual steps in the tutorials and then reference them in articles we have in our documentation. Matt suggested a solution in #577 to address a similar scenario with Parabricks.

  • Identify duplicate information in our docs
  • Restructure identified duplicate content and include crosslinks where necessary.
Where is the inaccuracy?
  1. LTS - https://docs.rc.uab.edu/data_management/lts/interfaces/#installation-of-s3cmd-and-s5cmd-on-cheaha has the same information as https://docs.rc.uab.edu/data_management/lts/tutorial/individual_lts_tutorial/#install-s3cmd-within-conda-environment-on-cheaha
  2. Conda - Conda potentially has similar issues, but we already have a plan for this.
  3. Parabricks - Scenario mentioned in #577.
  4. OSG - Scenario mention in #577.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.