Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Add GitHub pages deploy step to Travis config. #2940

Merged
merged 1 commit into from
Sep 24, 2019

Conversation

jeffstieler
Copy link
Contributor

@jeffstieler jeffstieler commented Sep 23, 2019

This PR seeks to introduce a deploy step on Travis that pushes the built docs/ folder to the gh-pages branch, since it now relies on a symlink to the packages/components/src directory.

The deploy should only occur on commits to master and on the PHP 7.2 / JS build.

Once this is merged and the first deploy occurs, we can switch the repo settings to build GH pages from the gh-pages branch.

Since travis-ci/dpl#989, this should copy the files symlinked. If that doesn't actually occur, this approach will need to be revisited - but we need to commit this to see if it works.

@jeffstieler jeffstieler force-pushed the add/gh-pages-build-step branch from d051344 to a8b0e9c Compare September 24, 2019 16:22
@jeffstieler jeffstieler requested a review from a team September 24, 2019 16:48
@jeffstieler jeffstieler added [Status] Needs Review type: documentation This issue is a request for better documentation. and removed status: in progress labels Sep 24, 2019
Copy link
Collaborator

@psealock psealock left a comment

Choose a reason for hiding this comment

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

Looks like good progress to me 🎉

@jeffstieler jeffstieler merged commit a69d059 into master Sep 24, 2019
@jeffstieler jeffstieler deleted the add/gh-pages-build-step branch September 24, 2019 20:01
@nerrad
Copy link
Contributor

nerrad commented Sep 24, 2019

Nifty! I wasn't aware of the docs for woocommerce admin until just now and I think this is awesome to have up. Gutenberg is just wrapping up implementing docs using Storybook. One thing I like about that approach is the live component views (which also verify they are working). I wonder if that's something we should consider implementing at some point as well?

@jeffstieler
Copy link
Contributor Author

Our live components live under WooCommerce > DevDocs (when running npm start from the repo).

It's probably best long term to just do it the Gutenberg Way ™️.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
tool: monorepo infrastructure type: documentation This issue is a request for better documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants