prerelease pipeline work #1123
prerelease pipeline work #1123
Conversation
…ntifying without external framing.
RELEASE.md
Outdated
| * `default`: [https://planet-sdk-for-python.readthedocs.io/](https://planet-sdk-for-python.readthedocs.io/) - Should point to same version as `stable`. | ||
| * `stable`: [https://planet-sdk-for-python.readthedocs.io/en/stable/](https://planet-sdk-for-python.readthedocs.io/en/stable/) - Should point to the highest stable release version. | ||
| * `latest`: [https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python.readthedocs.io/en/latest/) - Should point to the most recent build from `main`. | ||
| * _version_ : [https://planet-sdk-for-python.readthedocs.io/en/X.YY.ZZ/](https://planet-sdk-for-python.readthedocs.io/en/X.YY.Z/) - Should point to version `X.YY.ZZ`. |
There was a problem hiding this comment.
Should version have backticks? E.g. _version_.
There was a problem hiding this comment.
Heh. That's not the nit I was wondering here. I was wondering...
- "stable" and "latest" are literals. These are in URLs and such. I used monospace.
- "version" is a place holder. I used italics for "your value here"
- "default" is neither. both feel kinda wrong. Maybe italics more than monospace?
There was a problem hiding this comment.
could do both mono and italics. I kinda see that. Changing to that.
I think that sometimes renders funny.
- backtick underbar :
_version_ - underbar backtick:
version - backtick only :
version - underbar only : version
This is why Ora books have a whole preface on type conventions.
(and as your response shows, markdown is finicky as to the order of wrapping. That amuses me because that's exactly why Ye Olde HTML of 1994 evolved into more rigorous XML variants. I've always harbored a believe that Markdown forgot that history.)
No strong feelings. Consistency over nit picking here for me. What does the rest of the doc site do?
There was a problem hiding this comment.
Change applied.
There was a problem hiding this comment.
Aha! Your explanation about stable/latest vs version being a placeholder makes a lot of sense! My original comment is about consistency with the other properties in the list. I think keeping version as is makes a lot of sense now.
There was a problem hiding this comment.
yeah. Markdown isn't LaTeX. Sadly.
Work on the build and release process prior to fully spinning up a 3.0 development branch.
This MR was developed with changes over at our readthedocs projects to better handle the documentation for pre-release versions.
Concrete changes in this MR: