Skip to content
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

Clean up user guide example code and docs (pt 2) #1630

Merged
merged 5 commits into from
Apr 18, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Apr 17, 2024

This PR continues the work in #1584:

  • Moves user guide examples back into the examples directory so those examples can continue to be serialized and packaged for release, even though they are no longer being used to produce documentation.
  • Updates the custom auto_examples.py extension to exclude user guide examples from being processed and turned into Markdown files, since the user guide Markdown files now live in the flyte repo.
  • Removes "Getting Started" Markdown files that have been moved to the flyte repo and updates contributing guidelines to clarify where and how to contribute code and docs.

Note: Merge this PR before merging flyteorg/flyte#5207

@neverett neverett self-assigned this Apr 17, 2024
@neverett neverett requested a review from ppiegaze as a code owner April 17, 2024 17:32
Signed-off-by: nikki everett <[email protected]>
@neverett neverett merged commit 0ec8388 into master Apr 18, 2024
98 checks passed
@neverett neverett deleted the nikki/exclude-cleaned-examples branch April 18, 2024 20:25
getting_started/getting_started_with_workflow_development
getting_started/flyte_fundamentals
getting_started/core_use_cases
Quickstart guide <https://docs.flyte.org/en/latest/quickstart_guide.html>
Copy link
Contributor

@cosmicBboy cosmicBboy Apr 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neverett @ppiegaze btw these will be interpreted as external links by sphinx and will open a new tab when you click on these links (see flyteorg/flyte#5159). Can we use the actual path so that sphinx understands these as internal links?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay if there are external links in the index file in this repo since the actual index file for the docs site lives in the flyte repo. Anyone who builds flytesnacks docs locally should only be doing so to check specific integrations and/or tutorials pages, since almost all other docs live in flyte.

The ChatGPT agent link in https://docs.flyte.org/en/latest/deployment/agents/chatgpt.html#deployment-agent-setup-chatgpt needs to be fixed in the flyte repo, which I can take care of.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants