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

docs - Azure docs refactor #4316

Merged
merged 17 commits into from Jul 17, 2019

Conversation

tylergibson
Copy link
Contributor

@tylergibson tylergibson commented Jul 3, 2019

Several Refactoring actions for Documentation.

  1. Simplifying the structure of the Azure Docs to
  • Getting Started
  • Configuration
  • Examples
  • Advanced Usage
  • Reference
  1. Setting up a naming and organization convention for examples
  • Uses glob naming suffixes to allow examples to be grouped into multiple categories
  • Categories are based on the canonical organization of Azure service offerings
  • Examples have a primary focus name prefix to help with alphabetic sorting
  1. Moving developer docs into advanced usage, moving Azure Modes into the Functions configuration page.
  2. Grouping all core functionality into configuration section - auth, azure functions, and reporting output

Not implemented in this draft PR, but suggestions for further improvements:

  1. Getting started should be extended to walk through one end to end scenario showing a developer how to implement all of the core parts of a policy - auth, functions, and reporting.
  2. Promoting common filters/actions to top level nodes under Azure and renaming Azure Reference - to create the following Azure menu structure
  • Getting Started
  • Configure Azure Policies
  • Examples
  • Common Actions Reference
  • Common Filters Reference
  • Resources References
  • Advanced Usage
  1. Ensuring that each example has direct links to the associated actions, filters and resources by hyperlinking within the code block of the example.
  2. Ensuring references have links to their relevant examples.
  3. Adding an end 2 end scenarios section to the top of the example section for an additional 3-5 most common end to end scenarios.

https://tgibsonblobo.blob.core.windows.net/cloudcustodiandocs/html/index.html

@aluong aluong requested a review from logachev July 3, 2019 01:53
@aluong aluong self-assigned this Jul 3, 2019
@aluong aluong requested a review from stefangordon July 3, 2019 01:53
@aluong aluong added this to In progress in azure via automation Jul 3, 2019
@aluong
Copy link
Collaborator

aluong commented Jul 3, 2019

Do you mind throwing the html docs into a SA, so we can browse the changes?

@tylergibson
Copy link
Contributor Author

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 :)

@stefangordon stefangordon changed the title Draft PR - Azure docs refactor [wip] PR - Azure docs refactor Jul 3, 2019
@stefangordon
Copy link
Collaborator

stefangordon commented Jul 3, 2019

This looks awesome! Will take me a bit of time tomorrow to go over it.

Copy link
Collaborator

@stefangordon stefangordon left a 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/configuration/monitoring.rst Outdated Show resolved Hide resolved
docs/source/azure/configuration/serverlessfunctions.rst Outdated Show resolved Hide resolved
docs/source/azure/configuration/serverlessfunctions.rst Outdated Show resolved Hide resolved
docs/source/azure/gettingstarted.rst Outdated Show resolved Hide resolved
docs/source/index.rst Show resolved Hide resolved
docs/source/quickstart/index.rst Show resolved Hide resolved
@logachev logachev changed the title [wip] PR - Azure docs refactor PR - Azure docs refactor Jul 3, 2019
@logachev logachev changed the title PR - Azure docs refactor docs - Azure docs refactor Jul 4, 2019
@stefangordon
Copy link
Collaborator

stefangordon commented Jul 4, 2019

LGTM but want to wait till after holiday for others to review a few things.

docs/source/index.rst Outdated Show resolved Hide resolved
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.
Copy link
Collaborator

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:

...

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.
Copy link
Collaborator

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 ..."

@stefangordon stefangordon merged commit f10ebd3 into cloud-custodian:master Jul 17, 2019
azure automation moved this from In progress to Done Jul 17, 2019
alexkarpitski pushed a commit to mediapills/cloud-custodian that referenced this pull request Jul 29, 2019
fidelito pushed a commit to fidelito/cloud-custodian that referenced this pull request May 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
azure
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants