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

[doc] add product diagrams #1360

Merged
merged 5 commits into from
Jun 26, 2019
Merged

Conversation

jcalcaben
Copy link
Contributor

@jcalcaben jcalcaben commented Jun 17, 2019

Description

  • Add the product diagrams to appropriate topics in the doc site.
  • Update topic content to reflect current state of the project.
  • Clean up any linting errors in the modified topics.

Related Issue

Closes #1347

How have YOU tested this?

See verification steps

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Run linter on the technology overview file:
    npm run lint src/technologies/overview/index.md
  3. Verify no linting issues associated with this file.
  4. Run linter on the tools and library file:
    npm run lint src/technologies/tools-libraries/index.md
  5. Verify no linting issues associated with this file.
  6. Build and run the preview server: npm run develop
  7. Navigate to /technologies/overview/
  8. Verify the developer overview image is on the page.
  9. Navigate to /technologies/tools-libraries/
  10. Verify the tools and technology image is on the page.

Checklist:

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

@jcalcaben jcalcaben added pkg:pwa-devdocs documentation This pertains to documentation. version: Minor This changeset includes functionality added in a backwards compatible manner. docs documentation labels Jun 17, 2019
@vercel
Copy link

vercel bot commented Jun 17, 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://venia-git-jimothy-gh-1347product-diagrams.magento-research1.now.sh

@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jun 17, 2019

Messages
📖 We are currently working on automating the PR metadata checks. Until that time, you may see failures related to labels/description/linked issues/etc even if you have fixed the problem. Failures will persist until the next push (assuming they are fixed).

Generated by 🚫 dangerJS against fb2d4e2

@cherdman cherdman self-assigned this Jun 20, 2019
@supernova-at supernova-at self-assigned this Jun 25, 2019
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!

| [Redux](#redux) | <i class="material-icons green">check_box</i> | <i class="material-icons green">check_box</i> | |
| [GraphQL](#graphql) | <i class="material-icons green">check_box</i> | <i class="material-icons green">check_box</i> | <i class="material-icons green">check_box</i> |
{:style="table-layout:auto"}
| | Contributor | Frontend developer | Sysadmin/Devops/Backend developer |
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the difference between a contributor and a front end developer?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see a contributor as also having backend scripting skills to work on packages such buildpack or upward-js

@supernova-at
Copy link
Contributor

I was able to verify steps 1-5 but not past that (I may need Calcaben's help setting up my docs installation, I'm pretty sure it's something on my side).

As such, can whoever is QAing these please also run the verification steps?

@supernova-at supernova-at removed their assignment Jun 25, 2019
@dpatil-magento
Copy link
Contributor

@supernova-at I have that setup with bundler gem. So, you can skip these tickets to QA always. If you need bundler setup I can look into that as well.

@dpatil-magento dpatil-magento merged commit c73371a into develop Jun 26, 2019
@supernova-at supernova-at deleted the jimothy/gh-1347_product-diagrams branch July 25, 2019 15:10
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs version: Minor This changeset includes functionality added in a backwards compatible manner.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc]: Publish product diagrams
5 participants