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

Versioned Docs #3881

Closed
gormus opened this issue Jul 14, 2021 · 1 comment · Fixed by #11290
Closed

Versioned Docs #3881

gormus opened this issue Jul 14, 2021 · 1 comment · Fixed by #11290
Assignees

Comments

@gormus
Copy link

gormus commented Jul 14, 2021

Core or SDK?

Platform/SDK

Which part? Which one?

getsentry/sentry-php

Description

This is rather a feature request actually.

Due to dependencies, and locked versions, I cannot use the latest Sentry packages in my Drupal project.

I think it would be really helpful to access the documentation relevant to the version I use.

Could you make the documentation site to reflect the selected version, instead of displaying the latest all the time?

Suggested Solution

The user selects the platform they are interested in, they would see the latest documentation for the platform; but the user would be able to change the version from a drop-down list to access to the documentation matching the version they use in their project.

Here's an example (not the best I am afraid): https://drupal-graphql.gitbook.io/graphql/ (see the version links below the logo)

@jgillard
Copy link

jgillard commented Jul 15, 2024

I just hit this issue when trying to enable Replay on v7. I'm on v7 because I'm using the Loader script, which is not on the latest version of the JS SDK: getsentry/sentry-javascript#12187. The getting started instructions have changed between v7 and v8 and it took me a while to realise the live docs had the wrong info for what should be a supported setup. I had to go to archive.org to find a previous versions of your docs to fix my issue.

@getsantry getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 3 Jul 15, 2024
@stephanie-anderson stephanie-anderson moved this from Backlog to Todo in Docs Platform Jul 16, 2024
@stephanie-anderson stephanie-anderson changed the title Make documentation available for previous versions too Versioned Docs Jul 16, 2024
@chargome chargome assigned chargome and unassigned a-hariti Aug 27, 2024
@chargome chargome mentioned this issue Sep 9, 2024
16 tasks
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs Platform Oct 8, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Status: Done
Archived in project
Development

Successfully merging a pull request may close this issue.

7 participants