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.

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

Initial Data feed docs #3590

Merged
merged 16 commits into from
Jul 14, 2020
Merged

Initial Data feed docs #3590

merged 16 commits into from
Jul 14, 2020

Conversation

davymcaleer
Copy link

@davymcaleer davymcaleer commented May 5, 2020 •
edited by susanev
Loading

Signed-off-by: Davy McAleer dmcaleer@chef.io

🔩 Description: What code changed, and why?

Initial documentation around using the Data Feed functionality, including initial screenshots and outline setup instructions for review.

⛓️ Related Resources

Images included to walk through UI steps in Automate

👍 Definition of Done

Once complete details are available in order to allow a 3rd party do direct the described data feed output to an external system

👟 How to Build and Test the Change

Docs review - ensure all works within the documentation framework

✅ Checklist

📷 Screenshots, if applicable

Included!

@davymcaleer davymcaleer added documentation Anything related to the Automate docs. DO-NOT-MERGE data-feed data-feed-service for 3rd party integrations labels May 5, 2020
@davymcaleer davymcaleer requested a review from a team as a code owner May 5, 2020 09:02
@davymcaleer davymcaleer changed the title Initial Draft Data feed docs - DO NOT MERGE Initial Draft Data feed docs May 19, 2020
@davymcaleer davymcaleer changed the title Initial Draft Data feed docs Initial Draft Data feed docs - DO NOT MERGE May 19, 2020
@davymcaleer davymcaleer changed the title Initial Draft Data feed docs - DO NOT MERGE Initial Draft Data feed docs May 19, 2020
@davymcaleer davymcaleer changed the title Initial Draft Data feed docs Initial Data feed docs May 27, 2020
@davymcaleer davymcaleer mentioned this pull request May 27, 2020
Closed
4 tasks
davymcaleer
davymcaleer commented Jun 25, 2020
View reviewed changes
Copy link
Author

@davymcaleer davymcaleer left a comment

Choose a reason for hiding this comment

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

Updated comments following feedback from @mjingle

components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
davymcaleer
davymcaleer commented Jun 26, 2020
View reviewed changes
Copy link
Author

@davymcaleer davymcaleer left a comment

Choose a reason for hiding this comment

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

@mjingle all looks good with the edits - thank you! 🙇

msorens
msorens reviewed Jul 4, 2020
View reviewed changes
Copy link
Contributor

@msorens msorens left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! Documentation is power! 😁

components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
Davy McAleer and others added 13 commits July 9, 2020 16:20
Initial SNOW CMDB docs
a3c1f27 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
updates to remove images and correct testing errors
69a17ce 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
added section on updated_nodes_only parameter
198818a 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
image update and data feed syntax explainer
cd996d5 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
debug logging details
8404c16 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
fixed plurals needed in descriptions and title
3984719 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
updating default values
595e232 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
updating correct default values
002bcf9 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
updates following PR review
710fe93 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
Copyediting
99710d1 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
Incorporating feedback
c08db1a 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
addition of status codes and fqdn config
ed34edf 
Signed-off-by: Davy McAleer <dmcaleer@chef.io>
Feedback fixes
c5b18ce 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
@mjingle mjingle self-requested a review July 9, 2020 20:21
mjingle
mjingle approved these changes Jul 9, 2020
View reviewed changes
Copy link
Contributor

@mjingle mjingle left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This PR should be good now, @davymcaleer, but I will probably need to add a beta label onto this.

Header fix
49d75e2 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
@mjingle mjingle self-requested a review July 9, 2020 20:59
kagarmoe
kagarmoe suggested changes Jul 9, 2020
View reviewed changes
Copy link

@kagarmoe kagarmoe left a comment

Choose a reason for hiding this comment

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

Have discussed changes with Mary

Beta Banner warning
f264cce 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
@mjingle mjingle requested a review from kagarmoe July 10, 2020 17:34
kagarmoe
kagarmoe suggested changes Jul 10, 2020
View reviewed changes
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
components/automate-chef-io/content/docs/datafeed.md Outdated Show resolved Hide resolved
Feedback edits
148a92a 
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
@mjingle mjingle requested a review from kagarmoe July 10, 2020 18:10
mjingle
mjingle approved these changes Jul 10, 2020
View reviewed changes
Copy link
Contributor

@mjingle mjingle left a comment

Choose a reason for hiding this comment

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

@davymcaleer Thanks again! Docs are a go! 🟢

@davymcaleer davymcaleer merged commit dde56cd into master Jul 14, 2020
@chef-expeditor chef-expeditor bot deleted the davy-snow-docs branch July 14, 2020 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@susanev susanev susanev left review comments

@msorens msorens msorens left review comments

@satellite15 satellite15 satellite15 left review comments

@kagarmoe kagarmoe kagarmoe approved these changes

@mjingle mjingle mjingle approved these changes

Assignees
No one assigned
Labels
data-feed data-feed-service for 3rd party integrations documentation Anything related to the Automate docs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@davymcaleer @kagarmoe @susanev @mjingle @msorens @satellite15