-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Create a doc for updating the CMS #1076
Conversation
Deploy preview for cms-demo ready! Built with commit 95f62ae |
I don't know the reason why it failed. |
Is it possible to rerun the test build? |
Deploy preview for netlify-cms-www ready! Built with commit 95f62ae |
position: 24 | ||
--- | ||
|
||
# How updates to Netlify CMS are done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that this should be the same as the page title: "Updating the CMS".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
The preview shows the earlier version of heading, idk why. |
@ragasirtahk I recommend renaming it "CMS Version Updates," because "Updating the CMS" might imply to some that the page is about updating content in the CMS. Also, I would move the position to go after the pages around config and setup, since you're not likely to need to update the version on your first install. I'd say between Custom Previews and Architecture, so |
I think installation and upgrading should be documented together, but since our current setup doesn't really have a condensed "installation" guide, I'll second @verythorough's suggestion. For title, I'd say "Updating the CMS Version", but I don't have a really strong opinion on it. |
Renamed to "Updating the CMS Version". |
That reminds me! We have an issue for the installation doc: I'm fine merging this doc separately for now, but @ragasirtahk if you'd like to work on closing #731, that would be awesome, too. For the title, I'd prefer "Update the CMS Version" for two reasons: 1) it matches the other titles in the sidebar, and 2) it's a little less likely to wrap in the sidebar. |
Changed to "Update the CMS Version". As of now merge this doc separately. My exams start from tomorrow, I will start work on #731 in the last week of this month. |
I have a suggestion. The current "Hugo Site Starter" on https://www.netlifycms.org/docs/start-with-a-template/ uses https://github.com/netlify-templates/one-click-hugo-cms . The one click Hugo cms repository uses "Victor Hugo" and Netlify CMS which has a bit different structure from the original "Hugo" structure. I think the title should be changed to "Victor Hugo Site Starter" and a new template should be created for "Hugo Site Starter". This new template will only use pure "Hugo" and "Netlify CMS". Does it seems good to you? Should I create a new issue for this if you agree on my viewpoint? |
@ragasirtahk LGTM. Thanks for your contributions! |
- Summary
Fixes #1073 by creating a doc page about updating the CMS.
- Test plan
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)