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

Replace/Remove links to private Google Docs in Changelog page #510

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

mrshll1001
Copy link
Contributor

Related issues

Description

The HSDS Changelog headers attempt to link off to further information surrounding the release of that version. However, versions 1.0 downwards linked off to private google docs.

HSDS has only been semi-consistent in creating releases on Github for versions. Some version headers link to issue queries filtered by milestones. This is acceptable where no release exists, however others link off to private, non-public, Google docs.

I have replaced the 1.0 link to the official GH release link, and removed the others for which there is no milestone, label, or release tag.

This means that for versions 0.x down, there are currently no header links. Links to the GDocs remain in the body of the changelog for that version. In the future, if these details are pulled through onto a public page or backported into Github; we can modify the headings with new links.

Merge checklist

  • Update the changelog

If you have edited any schema files:

  • Run hsds_schema.py to update datapackage.json and example files
  • Update the logical model page if relevant

The HSDS Changelog headers attempt to link off to further information
surrounding the release of that version. However, versions 1.0 downwards
linked off to private google docs.

HSDS has only been semi-consistent in creating releases on Github for
versions. Some version headers link to issue queries filtered by
milestones. This is acceptable where no release exists, however others
link off to private, non-public, Google docs.

I have replaced the 1.0 link to the official GH release link, and
removed the others for which there is no milestone, label, or release
tag.

This means that for versions `0.x` down, there are currently no header
links. Links to the GDocs remain in the body of the changelog for that
version. In the future, if these details are pulled through onto a
public page or backported into Github; we can modify the headings with
new links.
@mrshll1001 mrshll1001 changed the base branch from 3.0 to 3.1-dev August 6, 2024 10:28
@greggish
Copy link
Member

greggish commented Aug 6, 2024

Thanks. The first couple of versions were managed in Google Docs. should we reclaim that content from the docs for historical purposes?

@mrshll1001 mrshll1001 merged commit 2117655 into 3.1-dev Sep 5, 2024
8 of 11 checks passed
@mrshll1001 mrshll1001 deleted the PATCH-tidy-changelog-header-links branch September 5, 2024 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

HSDS Changelog - all V0 headers link to a private Google Doc
2 participants