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.25% 90.25%
=======================================
Files 69 69
Lines 5561 5561
Branches 958 958
=======================================
Hits 5019 5019
Misses 523 523
Partials 19 19 ☔ 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 👍🏼
Co-authored-by: Juan Escalada <97265671+jescalada@users.noreply.github.com> Signed-off-by: Kris West <kristopher.west@natwest.com>
Signed-off-by: Kris West <kristopher.west@natwest.com>
Signed-off-by: Kris West <kristopher.west@natwest.com>
|
Updated, adding link to processors.md and an info box about git auth popups. I think this is good to go for now. Quoting specific error messages etc. could be a later refinement - perhaps worth addressing alongside revised UI and adding some screenshots @jescalada |
jescalada
left a comment
There was a problem hiding this comment.
LGTM! You're right, a detailed troubleshooting guide would make more sense with the UI updates merged in - screenshots are much more useful than plain messages. That said, keeping the error messages alongside the screenshots is best for SEO and UX.
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