Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

MAGECLOUD-2114 fix YAML formatting #4574

Merged
merged 5 commits into from
May 22, 2019
Merged

MAGECLOUD-2114 fix YAML formatting #4574

merged 5 commits into from
May 22, 2019

Conversation

hguthrie
Copy link
Contributor

@hguthrie hguthrie commented May 21, 2019 •
edited by dshevtsov
Loading

The purpose of this PR is to correct badly formatted YAML samples in the Cloud configure services topics. The services.yaml samples require 4 space indent.

I did have the opportunity to fix a few other minor things.

  • corrected the 'yaml' spacing in samples meant for the services.yaml file
  • created an include topic to accommodate repeating note about pretty printing relationships
  • corrected some unordered lists
  • added code blocks when missing
  • removed responses that I tested and were not accurate, but I did not have the bandwidth to test everything
  • scope creep: also checked YAML samples related to .magento.env.yaml. The magento-cloud template includes a DIST file which is a sample of the ENV config and it is formatted with 2 spaces; all other YAML sample seem to be 4 spaces

whatsnew
Reformatted YAML samples in the Configure Environments: Services section of the Cloud documentation.

@hguthrie hguthrie added Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies 2.x Internal Dev Differentiates work between community and Magento staff Technical Updates to the code or processes that alter the technical content of the doc labels May 21, 2019
@hguthrie hguthrie requested a review from jeff-matthews May 21, 2019 21:01
@hguthrie hguthrie self-assigned this May 21, 2019
jeff-matthews
jeff-matthews reviewed May 22, 2019
View reviewed changes
hguthrie and others added 3 commits May 22, 2019 10:29
@hguthrie
fix typos
3a9c7d6
@hguthrie
Adding other YAML files
a665e13 
In further conversation, decided to add other significant YAML samples in the check.
@hguthrie
fix formatting, spacing issues
955ea78
@hguthrie
Copy link
Contributor Author

running tests

@hguthrie hguthrie merged commit c43177a into master May 22, 2019
@ghost
Copy link

ghost commented May 22, 2019

Hi @hguthrie, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@hguthrie hguthrie deleted the hg-mc2114-yamlfix branch May 22, 2019 20:51
@dshevtsov dshevtsov mentioned this pull request May 28, 2019
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jeff-matthews jeff-matthews jeff-matthews approved these changes

Assignees

@hguthrie hguthrie

Labels
2.x Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies Internal Dev Differentiates work between community and Magento staff Technical Updates to the code or processes that alter the technical content of the doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hguthrie @jeff-matthews