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

Doc cleanup #640

Merged
merged 1 commit into from
Jun 6, 2022
Merged

Doc cleanup #640

merged 1 commit into from
Jun 6, 2022

Conversation

haydentherapper
Copy link
Contributor

The docs were out of date in a number of places, and information about
dev setup was duplicated. Changes:

  • config/DEVELOPMENT - Deleted, information was already in
    ca-kms-support
  • config/README - Out of date, Scaffolding should be used
  • docs/ctlog - Moved detail on test secret setup from DEVELOPMENT
  • docs/developer - Deleted, didn't add anything
  • docs/hsm-support - Removed duplicate info about setting up GCP CA
    Service, made the focus of the doc about HSM
  • docs/security-model - Removed extraneous info about timestamping and
    transparency logs, Fulcio isn't the right place. Left a little bit of
    detail still. This doc needs some revision and will likely be
    superseded by a threat model doc.
  • docs/setup - Small additions from DEVELOPMENT added

Misc:

  • Add back gcloud into docker-compose
  • Remove SPIFFE provider from test config

Signed-off-by: Hayden Blauzvern [email protected]

Summary

Ticket Link

Fixes

Release Note


The docs were out of date in a number of places, and information about
dev setup was duplicated. Changes:

* config/DEVELOPMENT - Deleted, information was already in
  ca-kms-support
* config/README - Out of date, Scaffolding should be used
* docs/ctlog - Moved detail on test secret setup from DEVELOPMENT
* docs/developer - Deleted, didn't add anything
* docs/hsm-support - Removed duplicate info about setting up GCP CA
  Service, made the focus of the doc about HSM
* docs/security-model - Removed extraneous info about timestamping and
  transparency logs, Fulcio isn't the right place. Left a little bit of
  detail still. This doc needs some revision and will likely be
  superseded by a threat model doc.
* docs/setup - Small additions from DEVELOPMENT added

Misc:
* Add back gcloud into docker-compose
* Remove SPIFFE provider from test config

Signed-off-by: Hayden Blauzvern <[email protected]>
Copy link
Member

@dlorenc dlorenc left a comment

Choose a reason for hiding this comment

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

Nice cleanups!

@haydentherapper haydentherapper merged commit 4451cba into sigstore:main Jun 6, 2022
@haydentherapper haydentherapper deleted the docs branch June 6, 2022 04:39
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.

None yet

2 participants