docs: add user manual for end-user contribution workflow#1528
docs: add user manual for end-user contribution workflow#1528
Conversation
✅ Deploy Preview for endearing-brigadeiros-63f9d0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Dependency ReviewThe following issues were found:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1528 +/- ##
=======================================
Coverage 90.21% 90.21%
=======================================
Files 69 69
Lines 5511 5511
Branches 944 944
=======================================
Hits 4972 4972
Misses 521 521
Partials 18 18 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jescalada
left a comment
There was a problem hiding this comment.
Looks good to me! Just wondering if we can add more details to the troubleshooting guide, mostly for SEO and UX reasons 👍🏼
|
|
||
| #### Checks applied to contributions | ||
|
|
||
| GitProxy applies a series of automated checks (called processors) to every push. These checks run in sequence, and if any check fails, the push is blocked. The main checks include: |
There was a problem hiding this comment.
Added link to the Processors.md guide for more details:
| GitProxy applies a series of automated checks (called processors) to every push. These checks run in sequence, and if any check fails, the push is blocked. The main checks include: | |
| GitProxy applies a series of automated checks (called [Processors](https://github.com/finos/git-proxy/blob/main/docs/Processors.md)) to every push. These checks run in sequence, and if any check fails, the push is blocked. The main checks include: |
| - Confirm no credentials, secrets, or PII are being exposed | ||
| - Provide constructive feedback when rejecting contributions | ||
|
|
||
| ### Troubleshooting |
There was a problem hiding this comment.
I'm wondering if we could specify the expected error messages here, similar to the troubleshooting guide for the v2 upgrade.
It'll help users identify their problem faster, and also improve the likelihood of finding this doc page when they (or their AI agents) Google the error message.
resolves #1525
Summary
Adds a new website/docs/user-manual.mdx page providing a comprehensive guide for end users contributing to projects through a GitProxy deployment.
Preview deeplink: https://deploy-preview-1528.git-proxy.preview.finos.org/docs/user-manual
Motivation
The existing documentation covers installation, configuration, and development but lacks a single end-to-end guide for the primary audience: developers pushing code through GitProxy. This page fills that gap.
What's included
Design decisions