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

Migrate netlify-cms-www site into this repo #860

Merged
merged 6 commits into from
Dec 5, 2017
Merged

Conversation

verythorough
Copy link
Contributor

@verythorough verythorough commented Dec 4, 2017

- Summary
Fixes #750
This consolidates the docs files and the Hugo site that built them into one folder, /website, here in the same repo with the code. Storing here makes for easier docs additions to code PRs, and keeps all contributors in the same place.

- Test plan
There are multiple sites built from this repo (cms-demo.netlify.com, now netlifycms.org, and soon to be a storybook build as well). I'm running a demo on a new test site until this PR is merged, then we'll need to change the build settings for the actual netlifycms.org site.

Here's the deploy preview on my test site:
https://deploy-preview-860--cms-migration-test.netlify.com

Here's the deploy preview on cms-demo, still functioning properly after the change:
https://deploy-preview-860--cms-demo.netlify.com

- Description for the changelog
Moved docs website within the code repo

- A picture of a cute animal (not mandatory but encouraged)
images

Some modifications, including most of the changes in netlify/netlify-cms-www#58 (previously reverted).

Also updated the readme and added hugo-bin for quicker onboarding of new docs contributors.
This allows separate build commands for cms-demo and netlifycms.org.
May re-add later, but it's not doing anything for now.
Copy link
Contributor Author

@verythorough verythorough left a comment

Choose a reason for hiding this comment

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

It's also worth mentioning that I moved the /docs folder into /website/site/content. This means github links to the files in /docs will no longer work.
We could keep all of the old files and replace their contents with a note of the new location, but that feels unnecessarily clunky to me.

@@ -1,3 +0,0 @@
[build]
Command = "npm run build && cp example/* dist/"
Publish = "dist"
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 removed this file because the build settings were overriding the ones needed for the docs build. These settings are set in the UI for the cms-demo site.

@@ -0,0 +1,94 @@
import gulp from "gulp";
import cp from "child_process";
import hugoBin from "hugo-bin"
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 added hugo-bin so contributors don't need to install Hugo for local testing.

@verythorough
Copy link
Contributor Author

Deploy preview ready!

Built with commit a67c378

https://deploy-preview-860--netlify-cms-www.netlify.com

@verythorough
Copy link
Contributor Author

I've locked deploys on the netlify-cms-www site, and switched settings over to point to the main netlify-cms repo. Deploy preview looks good, and even shows up in notifications ☝️

@verythorough verythorough merged commit 155f40e into master Dec 5, 2017
@verythorough verythorough deleted the migrate-website branch December 5, 2017 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants