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

[Docs] make is resulting in an error when trying to build the flytesnacks docs #2783

Closed
2 tasks done
Tracked by #2917
samhita-alla opened this issue Aug 18, 2022 · 16 comments · Fixed by flyteorg/flytesnacks#921
Closed
2 tasks done
Tracked by #2917
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@samhita-alla
Copy link
Contributor

Description

There shouldn't be any errors. Will have to fix indentations, broken links, and RST styles.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@samhita-alla samhita-alla added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Aug 18, 2022
@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Aug 19, 2022
@samhita-alla samhita-alla changed the title [Docs] make is resulting in an error when trying to build docs in flytesnacks [Docs] make is resulting in an error when trying to build the flytesnacks docs Aug 22, 2022
@techytushar
Copy link

techytushar commented Oct 19, 2022

@samhita-alla Please can you give some more info on how to reproduce this, from which folder do we need to run the make command.
I ran the make rsts and make html command from cookbook/docs folder and it worked without any errors (it did throw some warnings though)

@samhita-alla
Copy link
Contributor Author

@techytushar, yeah, we'll need to fix the warnings. Try running make linkcheck and you'll see some errors. We'll also need to fix the broken links.

@Azanul
Copy link

Azanul commented Oct 23, 2022

@techytushar Are you looking into it or can I give it a go?

@Azanul
Copy link

Azanul commented Oct 24, 2022

Taking this up as it seems stale

@Azanul
Copy link

Azanul commented Oct 24, 2022

#take

@Azanul
Copy link

Azanul commented Oct 26, 2022

@samhita-alla I don't know how to fix this

(auto/deployment/customizing_resources: line   47) broken    https://github.com/flyteorg/flytepropeller/blob/v0.10.5/config.yaml#L51,L56 - Anchor 'L51,L56' not found

@samhita-alla
Copy link
Contributor Author

samhita-alla commented Oct 27, 2022

I'm not sure if there's a way to fix them. For now, please ignore the anchor not found warnings.

@samhita-alla
Copy link
Contributor Author

@Azanul when can you create a PR?

@Azanul
Copy link

Azanul commented Oct 28, 2022

@samhita-alla I'll try by tonight.

@Azanul
Copy link

Azanul commented Oct 31, 2022

/workspaces/flytesnacks/cookbook/docs/auto/core/control_flow/subworkflows.rst:175: WARNING: undefined label: 'using multiple kubernetes clusters' /workspaces/flytesnacks/cookbook/docs/auto/core/type_system/structured_dataset.rst:86: WARNING: py:class reference target not found: flytekit.types.schema.FlyteSchema /workspaces/flytesnacks/cookbook/docs/auto/core/type_system/typed_schema.rst:62: WARNING: py:meth reference target not found: flytekit.types.schema.FlyteSchema.open /workspaces/flytesnacks/cookbook/docs/auto/core/type_system/typed_schema.rst:84: WARNING: py:meth reference target not found: flytekit.types.schema.FlyteSchema.open /workspaces/flytesnacks/cookbook/docs/auto/integrations/flytekit_plugins/greatexpectations/index.rst:25: WARNING: py:class reference target not found: flytekit.types.schema.FlyteSchema /workspaces/flytesnacks/cookbook/docs/auto/integrations/flytekit_plugins/sql/sql_alchemy.rst:58: WARNING: py:class reference target not found: flytekit.types.schema.FlyteSchema

@samhita-alla, I've fixed many but these still remain

@samhita-alla
Copy link
Contributor Author

samhita-alla commented Nov 1, 2022

@Azanul Have you created a PR?

@Azanul
Copy link

Azanul commented Nov 1, 2022

@Azanul Have you created a PR?

Yes, but in draft

@Azanul
Copy link

Azanul commented Nov 15, 2022

@samhita-alla just wasted my work.

@samhita-alla
Copy link
Contributor Author

samhita-alla commented Nov 16, 2022

@Azanul, you haven't linked any PR, so I assumed you haven't worked on it. Had you linked a PR, that'd have been nice. Moreover, you worked on this as part of Hacktoberfest. Since it's over, I thought you won't be working on it anymore.

@Azanul
Copy link

Azanul commented Nov 16, 2022

@samhita-alla
flyte_ss

@samhita-alla
Copy link
Contributor Author

Oh, I'm sorry. I missed it somehow. I saw your message and thought you haven't linked it yet. Sorry!

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

Successfully merging a pull request may close this issue.

5 participants