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

Establish publishing progression #12

Open
kcopas opened this issue May 4, 2019 · 3 comments
Open

Establish publishing progression #12

kcopas opened this issue May 4, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@kcopas
Copy link
Member

kcopas commented May 4, 2019

Maintaining draft or review documents in a labs URL makes sense, but once they are complete, we should have a stable, consistent location for the approved HTML versions, like docs.gbif.org or similar.

That URL—and not the GitHub repo—should then serve as the DOI reference, since it (should) provides access to all secondary versions, including PDFs and/or translations.

Propose that we review the update to the effective nodes guidance with @melianieraymond next week with an eye toward making it the first approved documentation residing in its proper place.

@kcopas kcopas added enhancement New feature or request help wanted Extra attention is needed labels May 4, 2019
@MattBlissett
Copy link
Member

One way to achieve this:

  • These are branches (not tags), to allow for small corrections to be made to old versions.
  • I configured test-document to build to labs for all branches. We could build to production only when a release is done, or a tag.

Would you prefer docs.gbif.org or documents.gbif.org, or something else?

@kcopas
Copy link
Member Author

kcopas commented May 7, 2019

This sounds like a promising, orderly process (I knew you'd know).

Just checked with @laurarussell, @dnoesgaard & @timhirsch — we're in the tank for docs.gbif.org.

@MattBlissett
Copy link
Member

This is implemented, except for having something to redirect to the latest version. I've set the versions to 1.0, but it could equally well be something like "2006".

The documents in development are at https://docs.gbif-uat.org/ .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants