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
docs - Azure docs refactor #4316
docs - Azure docs refactor #4316
Conversation
Do you mind throwing the html docs into a SA, so we can browse the changes? |
https://tgibsonblobo.blob.core.windows.net/cloudcustodiandocs/html/index.html :) |
This looks awesome! Will take me a bit of time tomorrow to go over it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really like the nav and examples updates. Just had some comments on content and probably some things for us to think through on install instructions.
docs/source/azure/examples/resourcegroupsorphanresources-general.rst
Outdated
Show resolved
Hide resolved
docs/source/azure/examples/sqldatabaselongtermbackupretention-databases.rst
Outdated
Show resolved
Hide resolved
docs/source/azure/examples/virtualmachinesresizeappplan-compute.rst
Outdated
Show resolved
Hide resolved
LGTM but want to wait till after holiday for others to review a few things. |
# Conflicts: # docs/source/azure/configuration/monitoring.rst
docs/source/azure/gettingstarted.rst
Outdated
on resources specified by filters. Custodian adheres to a compliance | ||
as code principle, so you can validate, dry-run, and code review on | ||
changes to your policies. | ||
The core concept is a stateless rule engine, that filters and takes actions on resources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reads a little funny to me ("core concept" of what? ). Not sure we have to repeat this whole paragraph from the index tbh.
I'd just do
Write your first policy
------------------------
Cloud Custodian is a stateless rules engine that filters and takes actions on Azure resources based on policies that you define.
Policies are expressed in YAML and include the following:
...
docs/source/index.rst
Outdated
on resources specified by filters. Custodian adheres to a compliance | ||
as code principle, so you can validate, dry-run, and code review on | ||
changes to your policies. | ||
The core concept is a stateless rule engine, that filters and takes actions on resources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This stateless rules engine bit is already in the paragraphs above (line 11). I'd just drop the sentence and start this with "Cloud Custodian can be bound to serverless event streams across multiple ..."
Several Refactoring actions for Documentation.
Not implemented in this draft PR, but suggestions for further improvements:
https://tgibsonblobo.blob.core.windows.net/cloudcustodiandocs/html/index.html