Update contributing docs #5830
Update contributing docs #5830
Conversation
… to docs contributing guide, plus make additional changes Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5830 +/- ##
==========================================
- Coverage 36.35% 36.34% -0.01%
==========================================
Files 1304 1304
Lines 110148 110148
==========================================
- Hits 40043 40037 -6
- Misses 65938 65944 +6
Partials 4167 4167
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
| @@ -30,7 +30,7 @@ Please join us on: | |||
| Open Source Community Meeting | |||
| ----------------------------- | |||
|
|
|||
| When: every other Tuesday, 9:00 AM Pacific Time. | |||
| When: Every other Thursday, 11:00 AM Pacific Time. | |||
There was a problem hiding this comment.
@davidmirror-ops is this accurate? And is the event link below (https://www.addevent.com/event/EA7823958) still correct?
Signed-off-by: nikki everett <[email protected]>
|
|
||
| ### Code in user guide documentation | ||
|
|
||
| If you want to include tested, runnable example code in user guide documentation, you will need to add your code to the examples directory of the [flytesnacks repository](https://github.com/flyteorg/flytesnacks). Write your code in regular Python, with regular comments. These comments **will not** be extracted from the Python file and turned into user-facing documentation. You can use the `rli` ([remoteliteralinclude](https://github.com/wpilibsuite/sphinxext-remoteliteralinclude/blob/main/README.md)) directive to include snippets of code from your example Python file. |
There was a problem hiding this comment.
This sentence reads oddly: "These comments will not be extracted from the Python file and turned into use-facing documentation"
The reader may be left wondering why exactly this particular fact about the comments is being called out.
There was a problem hiding this comment.
Good point -- this is to differentiate user guide examples in flytesnacks from tutorials and integrations examples in that repo, which have their comments turned into rendered docs. I can make that more explicit.
…python files in flytesnacks Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Why are the changes needed?
Make contributing to code and docs easier for Flyte community members.
Note: merge this PR first, then merge flyteorg/flytesnacks#1749, which depends on the changes in this PR.
What changes were proposed in this pull request?
How was this patch tested?
Local docs build.
Check all the applicable boxes
Related PRs
flyteorg/flytesnacks#1736
flyteorg/flytesnacks#1749
Docs link
https://flyte--5830.org.readthedocs.build/en/5830/community/contribute/index.html