Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "doc proxy" that styles and alters broker-generated docs page #6

Merged
merged 8 commits into from
Oct 21, 2024

Conversation

jameshochadel
Copy link
Contributor

Changes proposed in this pull request:

  • docproxy is a small Go app that will be exposed as a public route like https://services.fr.cloud.gov. https://cloud.gov will link to it and it will gradually replace the parts of the services documentation that are references for the service plans.
  • Docproxy makes the following changes to the docs page and could do more in the future:
    • Adds a favicon
    • Adds styles based on the USWDS
    • Removes leading whitespace from service titles
    • Sets a page title consistent with pages titles from https://cloud.gov
  • This PR does not include a deployment method for the app yet. That will likely go in deploy-cf.

Things to check

  • For any logging statements, is there any chance that they could be logging sensitive data?
  • Are log statements using a logging library with a logging level set? Setting a logging level means that log statements "below" that level will not be written to the output. For example, if the logging level is set to INFO and debugging statements are written with log.debug or similar, then they won't be written to the otput, which can prevent unintentional leaks of sensitive data.

Security considerations

The new application will improve security because we will not need to expose the entire CSB API surface in order to make the documentation page public. It does not accept any user input.

@jameshochadel jameshochadel marked this pull request as ready for review October 21, 2024 19:29
@jameshochadel jameshochadel requested a review from a team as a code owner October 21, 2024 19:29
Copy link

@JasonTheMain JasonTheMain 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, excited to see what it will looks like

@jameshochadel jameshochadel merged commit f83edc5 into main Oct 21, 2024
1 check passed
@jameshochadel jameshochadel deleted the docproxy branch October 21, 2024 19:33
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