Skip to content

Improve README and documentation #365

@rgmz

Description

@rgmz

The current README and documentation do not effectively communicate what Git Proxy is and how it works. A colleague of mine recently reviewed Git Proxy and dismissed it as insecure, perceiving that it was a client-side check that could be easily bypassed. Had I not already been familiar with the project, I likely would have come to the same conclusion.

For example, the first sentence in the README is "Git Proxy deploys custom push protections and policies on top of Git." accompanied with a picture of git push in the terminal.

It would be beneficial for the documentation to provide more clarity. Even a simple mermaid.js diagram showing that Git Proxy is an intermediary that blocks pushes or proxies them to an upstream would go a long way.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions