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
DM-42680: Add initial implementation of documentation workflow #38
Conversation
8081fc4
to
8fe1e6b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #38 +/- ##
=======================================
Coverage 93.36% 93.36%
=======================================
Files 20 20
Lines 2109 2109
Branches 425 425
=======================================
Hits 1969 1969
Misses 81 81
Partials 59 59 ☔ View full report in Codecov by Sentry. |
63049be
to
c577705
Compare
c577705
to
c6cd158
Compare
f56a5fd
to
5a3d3be
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small change requested
README.md
Outdated
columns: | ||
- "#sdqa_Threshold.sdqa_metricId" | ||
mysql:engine: MyISAM | ||
The [Felis documentation site](https://felis.lsst.io) provides more complete |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you move this to the top of the README, maybe as something like:
"Detailed information on usage, customization, and design is available at the Felis documentation site."
(since the sentence as it stands will read awkwardly if moved to the top unchanged)
5a3d3be
to
f26e0ba
Compare
Build the documentation using a compatible version of documenteer and upload for triggers other than PRs. For PRs, the documentation will be built but not uploaded.
dbf5e9d
to
240913d
Compare
@gpdf Let's do a re-review of this PR. I replaced the I don't think we should immediately link to the documentation site at the top, because it is already listed in the sidebar. The documentation as it exists is also not a good starting point for users to learn about the tool, as it starts with an overly discursive section and needs a pretty major overhaul. Maybe we could revisit this in the future once the actual site is in better shape and makes a better entry point for information? (I've still linked to it, just in a section that is closer to the bottom of the new README after the summary section. This is actually a similar README layout to several other popular tools like SQLAlchemy.) |
74b997f
to
23f6bae
Compare
The old README that duplicates the documentation site contents is replaced by a shorter RST version.
Update the workflow names so that they do not have underscores in them and are more easily readable on Github with a full description.
23f6bae
to
95ebc4b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK to proceed
Build the documentation using a compatible version of documenteer and upload for triggers other than PRs. For PRs, the documentation will be built but not uploaded. The README was the same as the documentation site, so it has been replaced by a more minimal text.