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] Dockerize flyteidl docs generation #2437

Closed
2 tasks done
MorpheusXAUT opened this issue May 3, 2022 · 0 comments · Fixed by flyteorg/flyteidl#295
Closed
2 tasks done

[Docs] Dockerize flyteidl docs generation #2437

MorpheusXAUT opened this issue May 3, 2022 · 0 comments · Fixed by flyteorg/flyteidl#295
Labels
documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers

Comments

@MorpheusXAUT
Copy link
Contributor

Description

Whilst most of the docs auto-generated for flyteidl are already using some docker image to build, one step still requires a local installation of protoc, which is not managed by the repo/boilerplate setup. Furthermore, the protoc version required/used is not documented anywhere (except when checking the GitHub actions workflow to see which one is auto-installed).

Generating all docs using Docker images would allow for an easier initial setup for flyteidl contributors as well as more consistent docs generation (no longer dependent on dependencies installed on local machine).

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

  • Yes

Have you read the Code of Conduct?

  • Yes
@MorpheusXAUT MorpheusXAUT added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels May 3, 2022
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 untriaged This issues has not yet been looked at by the Maintainers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant