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

Add action to pull auto generated docs from server #1183

Closed
Dr-Electron opened this issue Sep 25, 2023 · 1 comment · Fixed by #1248
Closed

Add action to pull auto generated docs from server #1183

Dr-Electron opened this issue Sep 25, 2023 · 1 comment · Fixed by #1248
Assignees
Labels

Comments

@Dr-Electron
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Currently we pull the SDK docs to build the API references. This is time consuming and not efficient as we pull on every build although the API references might not have changed. This will also happen for other API references which are not autogenerated yet, like for Identity or for the autogenerated config docs from app.go.

Describe the solution you'd like

The idea like it is described here https://github.com/iotaledger/devops/issues/377 would be to upload those files from the repos to a server so that the wiki can download them on build

Describe alternatives you've considered

It would also be possible to upload this files to the Releases, but that isn't really a nice solution imo

@github-project-automation github-project-automation bot moved this to Product Backlog in Developer Experience Sep 25, 2023
@Dr-Electron Dr-Electron moved this from Product Backlog to Sprint Backlog in Developer Experience Sep 25, 2023
@Dr-Electron Dr-Electron moved this from Sprint Backlog to In Progress in Developer Experience Sep 25, 2023
@Dr-Electron Dr-Electron moved this from In Progress to Blocked in Developer Experience Sep 25, 2023
@Dr-Electron
Copy link
Collaborator Author

Waiting for the merge before we do this

@Dr-Electron Dr-Electron moved this from Blocked to In Progress in Developer Experience Oct 9, 2023
@Dr-Electron Dr-Electron moved this from In Progress to Under Review in Developer Experience Oct 16, 2023
@github-project-automation github-project-automation bot moved this from Under Review to Done in Developer Experience Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants