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

Improve documentation for API app #1708

Closed
5 tasks
Tracked by #1707
tanya-borisova opened this issue Apr 20, 2022 · 0 comments · Fixed by #1801
Closed
5 tasks
Tracked by #1707

Improve documentation for API app #1708

tanya-borisova opened this issue Apr 20, 2022 · 0 comments · Fixed by #1801
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tanya-borisova
Copy link
Contributor

tanya-borisova commented Apr 20, 2022

Improve docs under https://microsoft.github.io/AzureTRE/tre-developers/api/

  • Do we still need to follow the manual steps as there's now a debug target in devcontainer doing it for us?
  • If we still need it, the manual steps should be moved to a script
  • Text around implementation details (Auth, Network requirements) should either go to a separate page or go away, as it distracts from setting up development with API app
  • Missing instructions on how to debug an instance deployed to the cloud
  • Explain how to work with Swagger UIs (different UIs for workspaces, Authorize button)
@joalmeid joalmeid self-assigned this Apr 21, 2022
@joalmeid joalmeid added the documentation Improvements or additions to documentation label Apr 26, 2022
@tanya-borisova tanya-borisova linked a pull request May 10, 2022 that will close this issue
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
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants