rstudio / rstudio/helm

Devise a way to keep the gh-pages branch up to date

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

Nobody has claimed this yet.

ci
Dominant language
Markdown
Stars
46
Forks
40
Avg merge
4h 3m
Merged PRs (30d)
6

Description

We should figure out how we want gh-pages to work:

  • should it have the same contents as the "parent" repository? if so, we should find a way to keep the README.md and dependent files (i.e. artifacthub-repo.yml, CONTRIBUTING.md, LICENSE, etc.) up to date
    • we should be aware that oftentimes relative links will break
  • should it be a completely separate / dedicated site? if so, how do we ensure that it is easy / sane to build / that information stays up to date?
    • Need to ensure index.yaml and artifacthub-repo.yml stay up to date

For reference, paired PRs (#36, #39)

To do:

  • investigate possibilities
  • decide on a direction
  • implement automation to ensure that the gh-pages branch can easily be monitored / kept up to date

Contributor guide

Open the contributing guide

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

Review paired PRs #36 and #39, then compare the gh-pages branch with the parent repository and the listed files, including README.md, artifacthub-repo.yml, CONTRIBUTING.md, LICENSE, and index.yaml. Decide whether gh-pages mirrors the parent or is a dedicated site, accounting for relative links. Done means a direction is chosen and automation is implemented to keep the branch up to date and monitorable.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, helm
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.