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.

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

[docs] Update devdocs dependencies #1957

Merged
merged 5 commits into from Nov 6, 2019

Conversation

jcalcaben
Copy link
Contributor

Description

Updates the node and ruby dependencies for the pwa-devdocs site project.
This PR also removes the {{site.baseurl}} prefixes from internal links since it is no longer required by Jekyll 4.

Acceptance

@jcalcaben

Verification Stakeholders

@jcalcaben

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Install updated deps: bundle install && npm install
  3. Build a production version of the docs: npm run build:production
  4. Verify build succeeds
  5. Rename _site directory to pwa-studio: mv _site pwa-studio
  6. Re-create _site directory and move pwa-studio into it: mkdir _site && mv pwa-studio _site
  7. Run an http server on _site: npx http-server _site
  8. Navigate to localhost:8080/pwa-studio
  9. Verify site renders.
  10. Click on links to other doc topics in top nav, side nav, and content
  11. Verify links to other topics within the docs are not broken

Screenshots / Screen Captures (if appropriate)

Checklist

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

@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Nov 4, 2019
@jcalcaben jcalcaben added version: Patch This changeset includes backwards compatible bug fixes. docs documentation documentation This pertains to documentation. pkg:pwa-devdocs labels Nov 4, 2019
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Nov 4, 2019

Fails
🚫

No linked issue found. Please link a relevant open issue by adding the text "closes #<issue_number>" or including the associated JIRA ID in your PR.

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 a5f3bb3

@supernova-at supernova-at self-assigned this Nov 5, 2019
@m2-community-project m2-community-project bot moved this from Ready for Review to Review in Progress in Pull Request Progress Nov 5, 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.

When I searched for site.baseurl in what's left I found the following:

Screen Shot 2019-11-05 at 9 39 31 AM

Not sure if they're still needed or not.

@supernova-at supernova-at moved this from Review in Progress to Changes Requested in Pull Request Progress Nov 5, 2019
@jcalcaben
Copy link
Contributor Author

These are still legitimate uses. Only links that use the link tag need to be updated since the base url is already prefixed.

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.

I did not run the verification steps. (I really need to get that set up...)

I can if you need.

@supernova-at supernova-at moved this from Changes Requested to Reviewer Approved in Pull Request Progress Nov 6, 2019
@jcalcaben
Copy link
Contributor Author

There's no need. @dpatil-magento has the docs environment set up and can verify

@dpatil-magento dpatil-magento moved this from Reviewer Approved to QA In Progress in Pull Request Progress Nov 6, 2019
@dpatil-magento dpatil-magento merged commit 191ea1b into develop Nov 6, 2019
@dpatil-magento dpatil-magento deleted the jimothy/update-devdocs-dependencies branch November 6, 2019 18:28
@m2-community-project m2-community-project bot moved this from QA In Progress to Done in Pull Request Progress Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs version: Patch This changeset includes backwards compatible bug fixes.
Development

Successfully merging this pull request may close these issues.

None yet

4 participants