Skip to content

docs: add user manual for end-user contribution workflow#1528

Merged
kriswest merged 11 commits into
mainfrom
user-manual
May 16, 2026
Merged

docs: add user manual for end-user contribution workflow#1528
kriswest merged 11 commits into
mainfrom
user-manual

Conversation

@kriswest

@kriswest kriswest commented May 8, 2026

Copy link
Copy Markdown
Contributor

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

  • Introduction explaining GitProxy's purpose and supported destinations
  • Mermaid sequence diagrams illustrating ingress and egress flows
  • Authentication guidance covering both proxy (PAT) and UI credentials
  • Overview of automated checks (with a note on plugin extensibility)
  • Instructions for setting up forks, configuring the git client, cloning, pushing, requesting review, and pushing approved changes
  • Reviewer workflow
  • Troubleshooting section covering common issues (credentials, blocked pushes, SSL errors, DCO sign-offs)

Design decisions

  • Written to be organisation-agnostic — uses :::info admonitions wherever deploying organisations' specific configuration will affect the answer (authentication method, checks applied, access provisioning).
  • Uses Mermaid diagrams (rendered natively by Docusaurus) rather than static images.
  • References existing docs (authentication, plugins, deployment) rather than duplicating content.

@kriswest kriswest requested a review from a team as a code owner May 8, 2026 13:58
@netlify

netlify Bot commented May 8, 2026

Copy link
Copy Markdown

Deploy Preview for endearing-brigadeiros-63f9d0 ready!

Name Link
🔨 Latest commit 0d6052c
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/6a074537af51c90008cedf00
😎 Deploy Preview https://deploy-preview-1528.git-proxy.preview.finos.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown

Dependency Review

The following issues were found:

  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 1 package(s) with unknown licenses.
  • ⚠️ 42 packages with OpenSSF Scorecard issues.

View full job summary

@codecov

codecov Bot commented May 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.25%. Comparing base (faeb58b) to head (0d6052c).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jescalada jescalada left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Just wondering if we can add more details to the troubleshooting guide, mostly for SEO and UX reasons 👍🏼

Comment thread website/docs/user-manual.mdx Outdated
Comment thread website/docs/user-manual.mdx
kriswest and others added 4 commits May 13, 2026 16:39
Co-authored-by: Juan Escalada <97265671+jescalada@users.noreply.github.com>
Signed-off-by: Kris West <kristopher.west@natwest.com>
Comment thread website/docs/user-manual.mdx Outdated
Comment thread website/docs/user-manual.mdx
Signed-off-by: Kris West <kristopher.west@natwest.com>
Signed-off-by: Kris West <kristopher.west@natwest.com>
@kriswest kriswest enabled auto-merge May 15, 2026 16:10
@kriswest

kriswest commented May 15, 2026

Copy link
Copy Markdown
Contributor Author

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 jescalada left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@kriswest kriswest merged commit 4c6e8d4 into main May 16, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add user manual to GitProxy documentation site

2 participants