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

Add information about versioning to intro.md #585

Closed
wants to merge 1 commit into from

Conversation

guayom
Copy link

@guayom guayom commented Sep 7, 2017

- Summary

Currently there is no information on how you can switch to another Netlify CMS version.

I just added a paragraph to explain how the versioning system works. I'll be happy to make adjustments if necessary.

https://unpkg.com/netlify-cms/dist/cms.js
https://unpkg.com/netlify-cms/dist/cms.css
```
Just keep in mind that the latest version might not be stable yet. Find out more about each version at the [releases page](https://github.com/netlify/netlify-cms/releases)
Copy link
Contributor

@tech4him1 tech4him1 Sep 7, 2017

Choose a reason for hiding this comment

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

@guayom This looks great. One thing I just found is that you can avoid pre-release (alpha, beta) versions by doing netlify-cms@* (with an asterisk): https://docs.npmjs.com/misc/semver#x-ranges-12x-1x-12-

Copy link
Contributor

Choose a reason for hiding this comment

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

@guayom Sorry for the confusion on this, I think @erquhart mentioned that we don't want to encourage people to just use the latest version. Maybe instead of this you could just link to the list of releases and give examples how to target them. Something like this might work:

  • @~0.4 for 0.4 stable
  • @>0.5.0-beta.1 for latest 0.5 beta

@@ -34,6 +34,14 @@ The admin interface is a single-page app with the entry point stored in a static
</html>
```

The example above uses the latest stable released version of Netlify CMS. If you want to a different release, you can explicitly declare it by editing `@~0.4`. If you want to use the latest version of Netlify CMS you can just omit the version declaration as such:
Copy link
Contributor

Choose a reason for hiding this comment

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

Second sentence: "If you want to use a different release," - the word "use" is omitted.

Once that's fixed, this is good to merge.

Thanks @guayom!

Copy link
Contributor

@Benaiah Benaiah left a comment

Choose a reason for hiding this comment

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

LGTM once @erquhart's and @tech4him1's comments are addressed.

@tech4him1
Copy link
Contributor

@guayom Can you update this so that we can get it merged?

@verythorough
Copy link
Contributor

This section was removed from the intro in favor of content in the quick start (now "Add to your site") and the upcoming installation doc.

@verythorough
Copy link
Contributor

@guayom, feel free to comment on #731 if you're interested in helping with the installation doc!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants