docs: Update documentation with standalone pages #550
Conversation
Add new documentation pages to the Hugo site: - codebase-walkthrough.md: Detailed repository structure and component walkthrough - onboarding.md: Learning path for new contributors - summaries.md: Technical summaries at different levels - faq.md: Frequently asked questions
✅ Deploy Preview for k8s-prow ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: deepsm007 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
cncf-cla: yes
|
Hi @deepsm007. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
the
size/XXL
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
|
|
||
| ## Repository Structure | ||
|
|
||
| The Prow repository follows a standard Go project layout with clear separation of concerns: |
There was a problem hiding this comment.
I'm not really sure there is such thing as a "standard" Go project layout. ;)
| ├── site/ # Documentation site | ||
| ├── test/ # Test files and test data | ||
| ├── hack/ # Build scripts and utilities | ||
| ├── Makefile # Build automation |
There was a problem hiding this comment.
Some indentation issues where the comments don't line up. Small thing that's probably fine to leave, but if you do an update it would be good to align them.
| title: "Codebase Walkthrough" | ||
| weight: 100 | ||
| description: > | ||
| Detailed explanation of the repository structure and key components |
There was a problem hiding this comment.
This kind of content always worries me to be included in docs since it's easy for things to get out of sync. But I think this is good with just the top level areas.
|
|
||
| #### Core Components | ||
|
|
||
| **Webhook and Event Handling:** |
There was a problem hiding this comment.
These are getting into the level of detail that gives me a little more concern about getting out of sync. But I do think this is some useful detail, so maybe worth it.
|
|
||
| ### What programming language is Prow written in? | ||
|
|
||
| Primarily Go (94.7%), with some TypeScript (2.5%) for the Deck frontend. |
There was a problem hiding this comment.
I do not think we need percentages of languages included in docs. Especially since GitHub gives this data automatically.
|
|
||
| **Deliverable**: Your first merged PR! | ||
|
|
||
| ## Learning Resources by Topic |
There was a problem hiding this comment.
I think the scope of this may be getting a little too large for this repo.
4 participants
Add new documentation pages to the Hugo site: