sourcefuse / sourcefuse/arc-docs
Update README to include subdirectory push instructions
Open
Nobody has claimed this yet.
documentation
- Dominant language
- No language data
- Stars
- 81
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We need to include in the README how to push subpages to arc-docs from Terraform modules.
Please reference terraform-aws-arc-github-iam for the subpage layout (.docs/*) and how .github/workflows/docs/yaml is structured for pushes to this repo.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README and compare the subpage layout in terraform-aws-arc-github-iam under .docs/*. Then review .github/workflows/docs/yaml to understand how pushes to this repository are structured. Done means the README explains both the subdirectory layout and the push instructions for Terraform modules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, terraform
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100