Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation guidance/instruction to to site subfolder. #1430

Closed
ADubhlaoich opened this issue Dec 29, 2023 · 2 comments
Closed

Add documentation guidance/instruction to to site subfolder. #1430

ADubhlaoich opened this issue Dec 29, 2023 · 2 comments
Assignees
@ADubhlaoich
Labels
enhancement New feature or request

Comments

@ADubhlaoich
Copy link
Contributor

User Story
As a person interested in contributing to documentation

I want to know how to write and test documentation changes

So that I can create improvements to the documentation

Acceptance Criteria
The site subfolder should have a README explaining how to use Hugo

The root README should direct people to the site README for doc contributions
@ADubhlaoich ADubhlaoich added the enhancement New feature or request label Dec 29, 2023
@ADubhlaoich ADubhlaoich self-assigned this Dec 29, 2023
@ADubhlaoich
Copy link
Contributor Author

I'm taking this task up. Most of the heavy lifting for this already exists in the repository for NGINX Ingress Controller: I will copy that README, make appropriate updates for a PR here, then add any improvements to their repository.

@ADubhlaoich ADubhlaoich mentioned this issue Dec 29, 2023
Merged
6 tasks
@mpstefan
Copy link
Collaborator

Completed by #1431

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ADubhlaoich ADubhlaoich

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ADubhlaoich @mpstefan