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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for Resource Processor #1709

Closed
6 of 7 tasks
Tracked by #1707
tanya-borisova opened this issue Apr 20, 2022 · 0 comments · Fixed by #1827
Closed
6 of 7 tasks
Tracked by #1707

Improve documentation for Resource Processor #1709

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

Comments

@tanya-borisova
Copy link
Contributor

tanya-borisova commented Apr 20, 2022 •
edited
Loading

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

  • Diagram is needed to show relationship between API, Resource Processor (RP) and Bundles. There is already one on Architecture page, but it isn't very detailed.
  • In section "Local development", make the JSON span over several lines instead of just one line
  • A paragraph on Porter should be moved to this doc instead of being on Architecture page
  • Do we need section on Network requirements?
  • Do we need "Challenges" section?
  • Need to mention where does RP gets the inputs it passes to bundles, and mention that RP is location agnostic
  • Missing instructions on how to debug in the cloud
@tanya-borisova tanya-borisova mentioned this issue Apr 20, 2022
Closed
3 tasks
@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 mentioned this issue May 12, 2022
Merged
@tanya-borisova tanya-borisova linked a pull request May 12, 2022 that will close this issue
Improve documentation for Resource Processor #1827
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tanya-borisova tanya-borisova

Labels
documentation Improvements or additions to documentation
Projects
No open projects
AzureTRE - Crew Rock
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation for Resource Processor microsoft/AzureTRE
2 participants
@joalmeid @tanya-borisova