foundriesio / docs

FoundriesFactory and Linux microPlatform documentation source for https://docs.foundries.io
Creative Commons Attribution 4.0 International
17 stars 27 forks source link

Decouple release notes from doc releases #719

Closed kprosise closed 4 months ago

kprosise commented 4 months ago

Replaced release note pages with external links. These point to Markdown documents on main, allowing release notes to easily be updated post-release.

This is a follow up to PR #718.

QA Steps: Checked rendered output and tested links

This commit addresses FFTK-3256

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer. If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

Overview

This commit is a quick-fix for decoupling the release notes from the docs, allowing the notes to easily be updated post release. This will likely be replaced with a Sphinx focused solution in the future.

Checklist

doanac commented 4 months ago

Docs for dd048be5fcb2c8813ca855d03bc2049cab232555 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2677/docs/artifacts/html/index.html

doanac commented 4 months ago

Docs for 39137d1193b3d21478ca4c109d9a894dff78a704 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2678/docs/artifacts/html/index.html

doanac commented 4 months ago

Docs for eb13013f50f263ec1a7ef9edc32b5c1ab7581872 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2679/docs/artifacts/html/index.html

angolini commented 4 months ago

I only want to note that it looks weird to have a link in the HTML that points to the GitHub source code.

For me, it's not a "decouple". And for me, it would be better to work for dot releases instead of adding a hack here.

kprosise commented 4 months ago

I only want to note that it looks weird to have a link in the HTML that points to the GitHub source code.

For me, it's not a "decouple". And for me, it would be better to work for dot releases instead of adding a hack here.

This is definitely not a long term solution, changing doc release process to include dot releases is definitely something we should consider. My goal here was to having something implemented in time for v94.