posit-dev / posit-dev/ptd

When ready to make docs public, add the publish github action workflow

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

Nobody has claimed this yet.

Dominant language
Go
Stars
7
Forks
2
Avg merge
1d 15h
Merged PRs (30d)
3

Description

Once we are ready for the docs to be public, we need to add an action to build the docs and deploy to the s3 bucket.

@AshleyHenry15 can grab a few examples from other teams and we can figure out what works for the team.

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

No files, tests, or entry points are named. Start by reviewing how the repository currently builds its docs and compare GitHub Actions examples from other teams, then confirm the intended S3 target and publication trigger with the team. Done means a documented workflow builds the docs and deploys them to the agreed S3 bucket.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, github-actions
Domain
ci-cd, cloud, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.