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

README: use apiclient set in introduction, explain raw mode separately #1418

Merged
merged 1 commit into from
Mar 26, 2021

Conversation

tjkirch
Copy link
Contributor

@tjkirch tjkirch commented Mar 25, 2021

Description of changes:

apiclient set simplifies the basic usage of the API quite a bit, so let's use that in the top-level README, and explain the more complex uses of the "raw mode" in the appropriate section of the apiclient README.

Testing done:

Ran all of the commands to confirm they work as expected. Rendered the docs to confirm they read as expected. (Although, GitHub is being funny about rendering the apiclient README for me...)

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

README.md Outdated Show resolved Hide resolved
@tjkirch
Copy link
Contributor Author

tjkirch commented Mar 25, 2021

^ This push simplifies the custom host-container example, per @bcressey. Tested that the new command worked.

sources/api/apiclient/README.md Show resolved Hide resolved
@tjkirch
Copy link
Contributor Author

tjkirch commented Mar 26, 2021

^ This push adds a couple more settings retrieval examples, per @etungsten.

Copy link
Contributor

@zmrow zmrow left a comment

Choose a reason for hiding this comment

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

📦

@tjkirch tjkirch merged commit 31bb1f6 into bottlerocket-os:develop Mar 26, 2021
@tjkirch tjkirch deleted the readme-apiclient-set branch March 26, 2021 22:15
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.

5 participants