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

Track REST API documentation #3291

Closed
8 tasks done
JerryHue opened this issue Mar 23, 2022 · 2 comments
Closed
8 tasks done

Track REST API documentation #3291

JerryHue opened this issue Mar 23, 2022 · 2 comments
Assignees
Labels
developer experience Helping the Developer Experience
Milestone

Comments

@JerryHue
Copy link
Contributor

JerryHue commented Mar 23, 2022

Issue #203 was created over a year ago, as an attempt to document the REST API that Telescope has. Since that issue has gone stale and does not have much context, I would like to revamp that issue into an issue that tracks all the documentation we need to write for the 3.0 release.

Add items to the list that you find to be necessary.

If you want to start the documentation for a specific service, hover over the item and click on the issue icon found to the right to open another issue that tracks the progress for that specific item.

@JerryHue JerryHue added the developer experience Helping the Developer Experience label Mar 23, 2022
@JerryHue JerryHue added this to the 3.0 Release milestone Mar 23, 2022
@JerryHue JerryHue pinned this issue Apr 12, 2022
@DukeManh
Copy link
Contributor

@JerryHue
Copy link
Contributor Author

@DukeManh, I think we can open a future issue that researches more about this. There would be a few services (the dependency-discovery comes to mind) that will have their API changed, so having an documentation tool that makes this easier would be helpful.

The idea is that the tool is, at the very least, compatible with Docusaurus, and that we can somehow install it in a monorepo?

@TueeNguyen TueeNguyen removed this from the 3.0 Release milestone Apr 22, 2022
@JerryHue JerryHue added this to the 3.0 Release milestone Apr 22, 2022
@cindyorangis cindyorangis unpinned this issue Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Helping the Developer Experience
Projects
None yet
Development

No branches or pull requests

4 participants