Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update README to include subdirectory push instructions

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
github-actions, terraform
Domain
documentation

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.

Description

documentation

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.

Dominant language
No language data
Stars
81
Forks
2
PR merge metrics
No merged PRs in 30d

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.

More from sourcefuse/arc-docs

All issues in sourcefuse/arc-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.