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 showing unreleased version #764

Closed
tijmenb opened this issue Sep 21, 2017 · 6 comments
Closed

Docs showing unreleased version #764

tijmenb opened this issue Sep 21, 2017 · 6 comments

Comments

@tijmenb
Copy link
Contributor

tijmenb commented Sep 21, 2017

At the moment there are a few PRs and commits that haven't been released to Rubygems yet. However, the Sentry docs system will show the unreleased docs from master, which could cause confusion.

A way to solve this is to create a branch latest-release every time we push to Rubygems, and add the following to sentry-docs/.gitmodules:

[submodule "doc-modules/raven-ruby"]
  path = doc-modules/raven-ruby
  url = https://github.com/getsentry/raven-ruby
+ branch = latest-release
@nateberkopec
Copy link
Contributor

A way to solve this is to create a branch latest-release every time we push to Rubygems, and add the following to sentry-docs/.gitmodules:

Ah, that's a great idea. Will do.

@dentarg
Copy link
Contributor

dentarg commented Sep 28, 2017

(This has been reported before in #666, it led to getsentry/sentry-docs#131 being opened)

@nateberkopec
Copy link
Contributor

OK, the official line is we're going to do more marking of version changed/added of particular features (even/especially when not yet released).

@dentarg
Copy link
Contributor

dentarg commented Oct 10, 2017

Shouldn't all unreleased changes be marked as such before closing this? Issue is still present, and others will likely trip over it until properly fixed (I know about it now, I think I will stick to browsing the docs per tag here on GitHub, but just want to help Sentry improve the service for newcomers)

@nateberkopec
Copy link
Contributor

@dentarg Well, I'm releasing a new version today so that will also fix the issue 😆

@dentarg
Copy link
Contributor

dentarg commented Oct 10, 2017

Haha 👍

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

No branches or pull requests

3 participants