WIP: Create initial documentation #2
Conversation
gmfrasca
force-pushed
the
init-docs
branch
2 times, most recently
from
39a1158 to
599b94b
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
Signed-off-by: Giulio Frasca <gfrasca@redhat.com>
Signed-off-by: Giulio Frasca <gfrasca@redhat.com>
hbelmiro
left a comment
hbelmiro
left a comment
There was a problem hiding this comment.
I left some comments.
Besides that, I think it will be easier for both contributors and maintainers if we keep the content of TESTING.md and ONBOARDING.md all in CONTRIBUTING.md.
We already have some duplicates between them.
docs/GOVERNANCE.md
Outdated
| - **Role**: Strategic decisions and governance | ||
| - **Members**: 5-7 senior community members | ||
| - **Term**: 2 years, staggered |
There was a problem hiding this comment.
How about linking to https://www.kubeflow.org/docs/about/governance/#2-kubeflow-steering-committee-ksc instead?
| *Get your development environment ready in just a few commands.* | ||
|
|
||
| ```bash | ||
| # Fork and clone | ||
| git clone https://github.com/YOUR_USERNAME/pipeline-components.git | ||
| cd pipeline-components | ||
| git remote add upstream https://github.com/kubeflow/pipeline-components.git | ||
|
|
||
| # Set up environment | ||
| uv venv | ||
| source .venv/bin/activate | ||
| uv pip install -r requirements-dev.txt | ||
|
|
||
| # Install pre-commit hooks | ||
| pre-commit install | ||
|
|
||
| # Verify setup | ||
| ./scripts/lint.sh | ||
| pytest | ||
| ``` |
There was a problem hiding this comment.
This duplicates the instructions from CONTRIBUTING.md. How about adding a link here?
There was a problem hiding this comment.
Good idea, but opposite: ONBOARDING.md is the developer setup guide, so this section should still live here, and CONTRIBUTING.md (guide on contribution patterns such as PR naming conventions, etc) should link to it
| pytest | ||
| ``` | ||
|
|
||
| ## Development Workflow |
There was a problem hiding this comment.
This also duplicates what we already have in CONTRIBUTING.md.
Signed-off-by: Giulio Frasca <gfrasca@redhat.com>
Signed-off-by: Giulio Frasca <gfrasca@redhat.com>
2 participants
No description provided.