Skip to content

Update README with new Minimum Config File and Clarification.#156

Open
jkinsfather wants to merge 12 commits intodevelopfrom
update-readme-6-25
Open

Update README with new Minimum Config File and Clarification.#156
jkinsfather wants to merge 12 commits intodevelopfrom
update-readme-6-25

Conversation

@jkinsfather
Copy link

This is a massive overhaul of the README.
The goals are:

  1. To make the information that is important more accessible.
  2. Add important caveats that were missing.
  3. Move unnecessary configuration information out of the core part of the README.
  4. Make the use cases for different possible configurations clearer.

@jkinsfather jkinsfather requested a review from tpetr as a code owner June 25, 2025 06:46
jkinsfather and others added 7 commits June 24, 2025 23:50
Removing reference to JIRA on-prem since it is not yet supported.

Signed-off-by: jk <139381146+jkinsfather@users.noreply.github.com>
Signed-off-by: jk <139381146+jkinsfather@users.noreply.github.com>
@semgrep-jamie
Copy link
Contributor

@jkinsfather fantastic improvement to the readme. Thank you so much. A couple of small suggestions from me but nothing big. Looks great!

jkinsfather and others added 3 commits June 25, 2025 10:24
Co-authored-by: semgrep-jamie <jamie@semgrep.com>
Signed-off-by: jk <139381146+jkinsfather@users.noreply.github.com>
Co-authored-by: semgrep-jamie <jamie@semgrep.com>
Signed-off-by: jk <139381146+jkinsfather@users.noreply.github.com>
Co-authored-by: semgrep-jamie <jamie@semgrep.com>
Signed-off-by: jk <139381146+jkinsfather@users.noreply.github.com>
@semgrep-jamie
Copy link
Contributor

Vivek & Matthew - if you could review the related & complementary #155 around the same time, your inputs would be valued!

@semgrep-jamie
Copy link
Contributor

@jkinsfather -- Thinking on this more, would it be more maintainable to move your excellent documentation to https://semgrep.dev/docs/semgrep-ci/network-broker and trim this README down to only contribution instructions?

One of the painpoints in broker setup right now is that there are multiple sources of truth which i believe confuses everyone.

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.

2 participants