docs overhaul: render flyteidl under the /api/ path #5802
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Niels Bantilan <[email protected]>
Signed-off-by: Niels Bantilan <[email protected]>
cosmicBboy
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## nikki/docs/flyte-docs-overhaul #5802 +/- ##
==================================================================
- Coverage 36.32% 34.44% -1.88%
==================================================================
Files 1304 1138 -166
Lines 110048 102666 -7382
==================================================================
- Hits 39970 35366 -4604
+ Misses 65922 63631 -2291
+ Partials 4156 3669 -487
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: Niels Bantilan <[email protected]>
Signed-off-by: Niels Bantilan <[email protected]>
neverett
approved these changes
Oct 3, 2024
* add css styling Signed-off-by: Niels Bantilan <[email protected]> * update logo height Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]>
cosmicBboy
merged commit 0893806
into
nikki/docs/flyte-docs-overhaul
18 of 21 checks passed
eapolinario
pushed a commit
that referenced
this pull request
Oct 4, 2024
* move flytekit and flytectl docs into API section Signed-off-by: nikki everett <[email protected]> * switch to docsearch module and env variables Signed-off-by: nikki everett <[email protected]> * reorganize content for pydata theme Signed-off-by: nikki everett <[email protected]> * more docs reorganization Signed-off-by: nikki everett <[email protected]> * switch to pydata theme Signed-off-by: nikki everett <[email protected]> * reorganize concepts/glossary and ecosystem docs Signed-off-by: nikki everett <[email protected]> * remove unneeded custom CSS and JS files Signed-off-by: nikki everett <[email protected]> * add redirects Signed-off-by: nikki everett <[email protected]> * add more redirects Signed-off-by: nikki everett <[email protected]> * first pass at updating docs contributing guide Signed-off-by: nikki everett <[email protected]> * remove core use cases Signed-off-by: nikki everett <[email protected]> * more edits to docs contributing guide Signed-off-by: nikki everett <[email protected]> * more edits to the flytesnacks contributing guide Signed-off-by: nikki everett <[email protected]> * add content to API reference index page, use consistent title and format for API reference section titles Signed-off-by: nikki everett <[email protected]> * rename deployment section Signed-off-by: nikki everett <[email protected]> * reorganize sections Signed-off-by: nikki everett <[email protected]> * fix typos Signed-off-by: nikki everett <[email protected]> * add docsearch index name and app id Signed-off-by: nikki everett <[email protected]> * add ref to docs contributing doc and move all docsearch stuff to env vars again Signed-off-by: nikki everett <[email protected]> * docs overhaul: render flyteidl under the /api/ path (#5802) * fix flyteidl structure so it renders under /api/ Signed-off-by: Niels Bantilan <[email protected]> * do not check in flyteidl docs Signed-off-by: Niels Bantilan <[email protected]> * update gitignore and unneeded conf Signed-off-by: Niels Bantilan <[email protected]> * add mock DOCSEARCH_API_KEY to docs test ci Signed-off-by: Niels Bantilan <[email protected]> * add css styling (#5803) * add css styling Signed-off-by: Niels Bantilan <[email protected]> * update logo height Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> * use same icon as union docs Signed-off-by: nikki everett <[email protected]> * sp error Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: nikki everett <[email protected]> Signed-off-by: Niels Bantilan <[email protected]> Co-authored-by: Niels Bantilan <[email protected]>
siiddhantt
pushed a commit
to siiddhantt/flyte
that referenced
this pull request
Oct 7, 2024
* move flytekit and flytectl docs into API section Signed-off-by: nikki everett <[email protected]> * switch to docsearch module and env variables Signed-off-by: nikki everett <[email protected]> * reorganize content for pydata theme Signed-off-by: nikki everett <[email protected]> * more docs reorganization Signed-off-by: nikki everett <[email protected]> * switch to pydata theme Signed-off-by: nikki everett <[email protected]> * reorganize concepts/glossary and ecosystem docs Signed-off-by: nikki everett <[email protected]> * remove unneeded custom CSS and JS files Signed-off-by: nikki everett <[email protected]> * add redirects Signed-off-by: nikki everett <[email protected]> * add more redirects Signed-off-by: nikki everett <[email protected]> * first pass at updating docs contributing guide Signed-off-by: nikki everett <[email protected]> * remove core use cases Signed-off-by: nikki everett <[email protected]> * more edits to docs contributing guide Signed-off-by: nikki everett <[email protected]> * more edits to the flytesnacks contributing guide Signed-off-by: nikki everett <[email protected]> * add content to API reference index page, use consistent title and format for API reference section titles Signed-off-by: nikki everett <[email protected]> * rename deployment section Signed-off-by: nikki everett <[email protected]> * reorganize sections Signed-off-by: nikki everett <[email protected]> * fix typos Signed-off-by: nikki everett <[email protected]> * add docsearch index name and app id Signed-off-by: nikki everett <[email protected]> * add ref to docs contributing doc and move all docsearch stuff to env vars again Signed-off-by: nikki everett <[email protected]> * docs overhaul: render flyteidl under the /api/ path (flyteorg#5802) * fix flyteidl structure so it renders under /api/ Signed-off-by: Niels Bantilan <[email protected]> * do not check in flyteidl docs Signed-off-by: Niels Bantilan <[email protected]> * update gitignore and unneeded conf Signed-off-by: Niels Bantilan <[email protected]> * add mock DOCSEARCH_API_KEY to docs test ci Signed-off-by: Niels Bantilan <[email protected]> * add css styling (flyteorg#5803) * add css styling Signed-off-by: Niels Bantilan <[email protected]> * update logo height Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> * use same icon as union docs Signed-off-by: nikki everett <[email protected]> * sp error Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: nikki everett <[email protected]> Signed-off-by: Niels Bantilan <[email protected]> Co-authored-by: Niels Bantilan <[email protected]> Signed-off-by: Siddhant Rai <[email protected]>
davidmirror-ops
pushed a commit
that referenced
this pull request
Oct 31, 2024
* Update registering_workflows.md Signed-off-by: Siddhant Rai <[email protected]> * feat: note in registering_workflows for k8sPod.dataConfig fix Signed-off-by: Siddhant Rai <[email protected]> * update: remove note as requested change Signed-off-by: Siddhant Rai <[email protected]> Signed-off-by: Siddhant Rai <[email protected]> * Flyte docs overhaul (phase 1) (#5772) * move flytekit and flytectl docs into API section Signed-off-by: nikki everett <[email protected]> * switch to docsearch module and env variables Signed-off-by: nikki everett <[email protected]> * reorganize content for pydata theme Signed-off-by: nikki everett <[email protected]> * more docs reorganization Signed-off-by: nikki everett <[email protected]> * switch to pydata theme Signed-off-by: nikki everett <[email protected]> * reorganize concepts/glossary and ecosystem docs Signed-off-by: nikki everett <[email protected]> * remove unneeded custom CSS and JS files Signed-off-by: nikki everett <[email protected]> * add redirects Signed-off-by: nikki everett <[email protected]> * add more redirects Signed-off-by: nikki everett <[email protected]> * first pass at updating docs contributing guide Signed-off-by: nikki everett <[email protected]> * remove core use cases Signed-off-by: nikki everett <[email protected]> * more edits to docs contributing guide Signed-off-by: nikki everett <[email protected]> * more edits to the flytesnacks contributing guide Signed-off-by: nikki everett <[email protected]> * add content to API reference index page, use consistent title and format for API reference section titles Signed-off-by: nikki everett <[email protected]> * rename deployment section Signed-off-by: nikki everett <[email protected]> * reorganize sections Signed-off-by: nikki everett <[email protected]> * fix typos Signed-off-by: nikki everett <[email protected]> * add docsearch index name and app id Signed-off-by: nikki everett <[email protected]> * add ref to docs contributing doc and move all docsearch stuff to env vars again Signed-off-by: nikki everett <[email protected]> * docs overhaul: render flyteidl under the /api/ path (#5802) * fix flyteidl structure so it renders under /api/ Signed-off-by: Niels Bantilan <[email protected]> * do not check in flyteidl docs Signed-off-by: Niels Bantilan <[email protected]> * update gitignore and unneeded conf Signed-off-by: Niels Bantilan <[email protected]> * add mock DOCSEARCH_API_KEY to docs test ci Signed-off-by: Niels Bantilan <[email protected]> * add css styling (#5803) * add css styling Signed-off-by: Niels Bantilan <[email protected]> * update logo height Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> * use same icon as union docs Signed-off-by: nikki everett <[email protected]> * sp error Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: nikki everett <[email protected]> Signed-off-by: Niels Bantilan <[email protected]> Co-authored-by: Niels Bantilan <[email protected]> Signed-off-by: Siddhant Rai <[email protected]> * [Flyte][3][flytepropeller][Attribute Access][flytectl] Binary IDL With MessagePack (#5763) Signed-off-by: Siddhant Rai <[email protected]> * Update aws-go-sdk to v1.47.11 to support EKS Pod Identity (#5796) Signed-off-by: Siddhant Rai <[email protected]> * Update docs/user_guide/flyte_fundamentals/registering_workflows.md Co-authored-by: Nikki Everett <[email protected]> Signed-off-by: Siddhant Rai <[email protected]> * Update registering_workflows.md Signed-off-by: Siddhant Rai <[email protected]> --------- Signed-off-by: Siddhant Rai <[email protected]> Signed-off-by: Siddhant Rai <[email protected]> Signed-off-by: nikki everett <[email protected]> Signed-off-by: Niels Bantilan <[email protected]> Co-authored-by: Nikki Everett <[email protected]> Co-authored-by: Niels Bantilan <[email protected]> Co-authored-by: Future-Outlier <[email protected]> Co-authored-by: mthemis-provenir <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds on top of #5772. This moves around some flyteidl-related docs and configuration so that flyteidl renders under the
/api/path.