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

Modernize docs (Round 1) #1363

Merged
merged 15 commits into from
Jun 7, 2024
Merged

Modernize docs (Round 1) #1363

merged 15 commits into from
Jun 7, 2024

Conversation

mlw
Copy link
Contributor

@mlw mlw commented May 30, 2024

This PR begins a major overhaul to Santa docs, making them current with the current state of the project.

Due to size, this PR does not attempt to update all docs at once in hopes of eliciting better reviews.

@mlw mlw added the docs Documentation-related issues label May 30, 2024
@mlw mlw requested a review from a team as a code owner May 30, 2024 16:53
@russellhancox russellhancox requested a review from kathancox May 30, 2024 17:02
docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/binaries/santabundleservice.md Outdated Show resolved Hide resolved
docs/binaries/santabundleservice.md Show resolved Hide resolved
docs/binaries/santabundleservice.md Outdated Show resolved Hide resolved
docs/binaries/santabundleservice.md Show resolved Hide resolved
docs/deployment/configuration.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/syncing-overview.md Outdated Show resolved Hide resolved
docs/introduction/syncing-overview.md Outdated Show resolved Hide resolved
docs/introduction/syncing-overview.md Outdated Show resolved Hide resolved
docs/binaries/santabundleservice.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/syncing-overview.md Outdated Show resolved Hide resolved
docs/binaries/santabundleservice.md Show resolved Hide resolved
docs/binaries/santad.md Outdated Show resolved Hide resolved
docs/concepts/ipc.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kathancox kathancox left a comment

Choose a reason for hiding this comment

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

Suggestions enclosed, hope this is helpful!

docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/binary-authorization-overview.md Outdated Show resolved Hide resolved
docs/introduction/syncing-overview.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pmarkowsky pmarkowsky 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 overall. Noticed one redundant sentence.

docs/binaries/santa-gui.md Outdated Show resolved Hide resolved
@mlw mlw force-pushed the modernize-docs-round-1 branch from ddc4090 to 08845eb Compare June 4, 2024 15:10
@mlw mlw requested a review from pmarkowsky June 4, 2024 16:07
mlw and others added 15 commits June 4, 2024 16:10
Only some of the comments are included in this first commit.

Co-authored-by: Kathryn May <44557882+kathancox@users.noreply.github.com>
Co-authored-by: Russell Hancox <russellhancox@users.noreply.github.com>
Adding some more suggestions. Still more to go through.

Co-authored-by: Kathryn May <44557882+kathancox@users.noreply.github.com>
Co-authored-by: Russell Hancox <russellhancox@users.noreply.github.com>
More commits from reviewers

Co-authored-by: Kathryn May <44557882+kathancox@users.noreply.github.com>
Co-authored-by: Russell Hancox <russellhancox@users.noreply.github.com>
Co-authored-by: Pete Markowsky <pmarkowsky@users.noreply.github.com>
More PR suggestions

Co-authored-by: Pete Markowsky <pmarkowsky@users.noreply.github.com>
Co-authored-by: Kathryn May <44557882+kathancox@users.noreply.github.com>
Co-authored-by: Pete Markowsky <pmarkowsky@users.noreply.github.com>
@mlw mlw force-pushed the modernize-docs-round-1 branch from 08845eb to 070afe9 Compare June 4, 2024 20:10
@mlw mlw merged commit e8b7fdf into google:main Jun 7, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants