Skip to content

Add quick pointers to various public docs. #864

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 6, 2022
Merged

Add quick pointers to various public docs. #864

merged 3 commits into from
Oct 6, 2022

Conversation

@qingling128
Copy link
Contributor

@qingling128 qingling128 commented Sep 20, 2022 •
edited
Loading

Description

The ops agent README.md right now just points to the Google Cloud doc page. Pain points we heard: For many devs the README is the entry point for them when evaluating a repo. For example, we could add a quick install / setup guide. Instead of maintaining two copies, we provide some quick links to the public site.

Related issue

b/233066135

How has this been tested?

N/A

Checklist:

  • Unit tests
    • Unit tests do not apply.
    • Unit tests have been added/modified and passed for this PR.
  • Integration tests
    • Integration tests do not apply.
    • Integration tests have been added/modified and passed for this PR.
  • Documentation
    • This PR introduces no user visible changes.
    • This PR introduces user visible changes and the corresponding documentation change has been made.
  • Minor version bump
    • This PR introduces no new features.
    • This PR introduces new features, and there is a separate PR to bump the minor version since the last release already.
    • This PR bumps the version.

@qingling128 qingling128 requested review from a team and jkschulz and removed request for a team September 20, 2022 04:28
jefferbrecht
jefferbrecht reviewed Oct 6, 2022
View reviewed changes
@qingling128 @jefferbrecht
Update README.md
c73b180 
Co-authored-by: Jeff Erbrecht <89024676+jefferbrecht@users.noreply.github.com>
@qingling128 qingling128 merged commit 9a082c1 into master Oct 6, 2022
@qingling128 qingling128 deleted the lingshi-doc branch October 6, 2022 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jefferbrecht jefferbrecht jefferbrecht approved these changes

@avilevy18 avilevy18 avilevy18 approved these changes

@jkschulz jkschulz Awaiting requested review from jkschulz jkschulz was automatically assigned from GoogleCloudPlatform/stackdriver-reviewers

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@qingling128 @jefferbrecht @avilevy18