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

[DOCS] Added a Prerequisites info box to the how-to guide template #1491

Merged
merged 4 commits into from
May 27, 2020
Merged

[DOCS] Added a Prerequisites info box to the how-to guide template #1491

merged 4 commits into from
May 27, 2020

Conversation

eugmandel
Copy link
Contributor

@eugmandel eugmandel commented May 27, 2020 •
edited

Changes proposed in this pull request:

  • Added a new info box to the how-to guide template (see the screenshot)
  • Modified one guide to add the info box.

image

Previous Design Review notes:

  • The change was done after a discussion at a prod eng session.
  • The changes were reviewed and updated with @abegong

Thank you for submitting!

@coveralls
Copy link

coveralls commented May 27, 2020 •
edited

Coverage Status

Coverage decreased (-4.5%) to 72.415% when pulling 2d2e2d1 on eugene/how_to_guide_template_update_2020_05 into 39fcbf0 on develop.

@codecov
Copy link

codecov bot commented May 27, 2020 •
edited

Codecov Report

Merging #1491 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1491   +/-   ##
========================================
  Coverage    76.90%   76.90%           
========================================
  Files          130      130           
  Lines        14787    14787           
========================================
  Hits         11372    11372           
  Misses        3415     3415

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39fcbf0...2d2e2d1. Read the comment docs.

abegong
abegong approved these changes May 27, 2020
View reviewed changes
Copy link
Member

@abegong abegong left a comment

Choose a reason for hiding this comment

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

❤️

abegong
abegong approved these changes May 27, 2020
View reviewed changes
Copy link
Member

@abegong abegong left a comment

Choose a reason for hiding this comment

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

❤️

abegong
abegong requested changes May 27, 2020
View reviewed changes
Copy link
Member

@abegong abegong left a comment

Choose a reason for hiding this comment

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

Actually, please put the admonition in the template (how_to_guides__miscellaneous__how_to_template), not "How to write a how-to guide."

@abegong abegong mentioned this pull request May 27, 2020
Merged
@eugmandel
Updated the how-to guide for writing how-to guides and moved the prer…
9ba43cc 
…equisites info box from the guide into the template
@eugmandel
Copy link
Contributor Author

how_to_guides__miscellaneous__how_to_template

Moved the info box and updated the how-to guide.

@eugmandel eugmandel requested a review from abegong May 27, 2020 15:23
Aylr
Aylr approved these changes May 27, 2020
View reviewed changes
Copy link
Contributor

@Aylr Aylr left a comment

Choose a reason for hiding this comment

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

LGTM

@jcampbell jcampbell merged commit 2cb5b17 into develop May 27, 2020
@jcampbell jcampbell deleted the eugene/how_to_guide_template_update_2020_05 branch May 27, 2020 19:29
Shinnnyshinshin pushed a commit that referenced this pull request May 29, 2020
@eugmandel
[DOCS] Added a Prerequisites info box to the how-to guide template (#…
d1e2111 
…1491)

* Added a Prerequisites info box to the how-to guide template (+ 1 example)

* edits to the wording of the info box

* Updated the how-to guide for writing how-to guides and moved the prerequisites info box from the guide into the template
alexsherstinsky pushed a commit to alexsherstinsky/great_expectations that referenced this pull request Feb 19, 2021
@eugmandel
[DOCS] Added a Prerequisites info box to the how-to guide template (g…
4db111f 
…reat-expectations#1491)

* Added a Prerequisites info box to the how-to guide template (+ 1 example)

* edits to the wording of the info box

* Updated the how-to guide for writing how-to guides and moved the prerequisites info box from the guide into the template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Aylr Aylr Aylr approved these changes

@jcampbell jcampbell Awaiting requested review from jcampbell

@abegong abegong Awaiting requested review from abegong

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@eugmandel @coveralls @Aylr @abegong @jcampbell