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

A redirect to the latest documentation of a package #174

Closed
patricoferris opened this issue Oct 27, 2021 · 8 comments · Fixed by #551
Closed

A redirect to the latest documentation of a package #174

patricoferris opened this issue Oct 27, 2021 · 8 comments · Fixed by #551
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@patricoferris
Copy link
Contributor

Currently we only have a redirect to the latest package's "home" page i.e. at the time of writing https://v3.ocaml.org/p/irmin goes to https://v3.ocaml.org/p/irmin/2.8.0.

We might also want a redirect that takes people directly to the latest documentation of a package so perhaps https://v3.ocaml.org/p/irmin/docs goes to https://v3.ocaml.org/p/irmin/2.8.0/doc/index.html -- this would be useful for people to add to their READMEs/Websites pointing to the latest API of a package.

We should also perhaps advertise these redirects on the packages landing page for people to use (I already do that when looking up APIs for example)

cc: @craigfe (who was looking for something like this)

@patricoferris patricoferris added enhancement New feature or request good first issue Good for newcomers labels Oct 27, 2021
@olivcamj
Copy link

olivcamj commented Oct 27, 2021

Hi @patricoferris, I am an Outreachy applicant and I would like to work on this issue. Any pointers on getting started?

@tmattio
Copy link
Collaborator

tmattio commented Oct 27, 2021

Hi @olivcamj 🙂 Were you able to setup the project already? We're asking applicants to get up and running before we assign them to an issue.

@olivcamj
Copy link

Hi @tmattio, yes ✅ I was able to set up the project and I completely understand I know that errors during the initial project setup can be a major setback.

@NiraliJoshi17
Copy link

hello, @patricoferris @tmattio , I am an Outreachy applicant and I would like to contribute to this issue.

@tmattio
Copy link
Collaborator

tmattio commented Oct 28, 2021

@olivcamj Perfect, in this case you can start on this issue, no problem 🙂
@NiraliJoshi17, the issue was already asked to be assigned by another Outreachy applicant, so I'll let you choose another one. Also, can you confirm that your environment is setup and that you can run the server locally?

@NiraliJoshi17
Copy link

@tmattio yes, I am done with the environment setup and I can run the server locally.

@olivcamj
Copy link

@tmattio Ok thank you!

@cdaringe
Copy link
Contributor

let documentation_url =
  Sys.getenv_opt "OCAMLORG_DOC_URL"
  |> Option.value ~default:"https://docs-data.ocaml.org/live/"

=> invalid cert, & 403s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants