Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

[doc] environment variables documentation #1566

Merged
merged 6 commits into from
Aug 19, 2019
Merged

[doc] environment variables documentation #1566

merged 6 commits into from
Aug 19, 2019

Conversation

jcalcaben
Copy link
Contributor

Description

  • Updates the build commands in the pwa-devdoc's project to fit the pattern used in the pwa-studio projects.
  • Creates a script to build auto-generated documentation content from the /packages/pwa-buildpack/envVarDefinitions.json file
  • Creates a draft topic that includes the auto-generated documentation

Related Issue

Closes #1563

Verification Steps

  1. Navigate to the pwa-devdocs directory: cd pwa-devdocs
  2. Build the HTML: npm run build
  3. Verify the auto-generated doc is created at: src/_includes/auto-generated/buildpack/reference/envVarDefinitions.md
  4. Verify the markdown file contains the same data as the /packages/pwa-buildpack/envVarDefinitions.json file

Note:
There is no need to run the HTML server since this topic will not be published until the actual buildpack CLI feature is released.

Screenshots / Screen Captures (if appropriate)

n/a

Proposed Labels for Change Type/Package

  • major (e.g x.0.0 - a breaking change)
  • minor (e.g 0.x.0 - a backwards compatible addition)
  • patch (e.g 0.0.x - a bug fix)

Checklist:

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.

@vercel
Copy link

vercel bot commented Aug 15, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://pwa-studio-git-jimothy-environment-variables-documentation.mmansoor.now.sh

@jcalcaben jcalcaben added docs documentation documentation This pertains to documentation. pkg:pwa-buildpack pkg:pwa-devdocs version: Major This changeset includes incompatible API changes and its release necessitates a Major version bump. labels Aug 15, 2019
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Aug 15, 2019 •
edited
Loading

Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.
📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).

Generated by 🚫 dangerJS against 8d19097

@supernova-at supernova-at self-assigned this Aug 16, 2019
supernova-at
supernova-at approved these changes Aug 16, 2019
View reviewed changes
Copy link
Contributor

@supernova-at supernova-at left a comment

Choose a reason for hiding this comment

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

Looks good to me 👍

@jcalcaben
Copy link
Contributor Author

I think @zetlen said he wanted to take a look at this PR too

zetlen
zetlen approved these changes Aug 19, 2019
View reviewed changes
Copy link
Contributor

@zetlen zetlen left a comment

Choose a reason for hiding this comment

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

Looks great to me! Thanks for going to the trouble of making this. We'll keep trying to make our code as machine-parseable as possible so you can autogenerate docs like this.

pwa-devdocs/package.json
"build-js": "webpack --config webpack.config.js",
"build-production": "npm-run-all -s clean build-js build-css && jekyll build --source src/ --config src/_config.yml,_config-production.yml",
"build-reference-doc-snippets": "node scripts/create-reference-docs",
"build": "npm-run-all -s build:js build:css build:reference-doc-snippets build:compatibility-table build:env-var-definition-doc build:html",
Copy link
Contributor

Choose a reason for hiding this comment

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

Do these scripts have to run in series? If not, there's a way you can simplify this a lot.

@dpatil-magento dpatil-magento merged commit 5c4e5f8 into develop Aug 19, 2019
@dpatil-magento dpatil-magento deleted the jimothy/environment-variables-documentation branch August 19, 2019 16:49
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@zetlen zetlen zetlen approved these changes

@supernova-at supernova-at supernova-at approved these changes

Assignees

@zetlen zetlen

@supernova-at supernova-at

Labels
docs documentation documentation This pertains to documentation. pkg:pwa-buildpack pkg:pwa-devdocs version: Major This changeset includes incompatible API changes and its release necessitates a Major version bump.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[doc]: Environment variables documentation
5 participants
@jcalcaben @PWAStudioBot @zetlen @supernova-at @dpatil-magento