Skip to content

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

Open
kriswest wants to merge 5 commits intomainfrom
user-manual
Open

docs: add user manual for end-user contribution workflow#1528
kriswest wants to merge 5 commits intomainfrom
user-manual

Conversation

@kriswest
Copy link
Copy Markdown
Contributor

@kriswest kriswest commented May 8, 2026

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
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for endearing-brigadeiros-63f9d0 ready!

Name Link
🔨 Latest commit 666ec39
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/69fdfe9d8a283600088524ef
😎 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
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

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
Copy link
Copy Markdown

codecov Bot commented May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.21%. Comparing base (fd1c648) to head (666ec39).

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.
📢 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.

Copy link
Copy Markdown
Contributor

@jescalada jescalada left a comment

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 👍🏼


#### 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:
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.

Added link to the Processors.md guide for more details:

Suggested change
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
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.

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.

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