microsoft / microsoft/AzureTRE

firewall docs need updating

Open
#4,729 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
235
Forks
192
Avg merge
1d 23h
Merged PRs (30d)
13

Description

Describe the bug
As per #4451 the install step is now supported (docs say it isn't)

I feel that the firewall docs can be enhanced to explain how resource.properties, resource.parent.properties (requires a workspace upgrade step to pass a param to a workspace-service) are passed (and that main needs to run first)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the firewall documentation and review issue #4451 for the updated install-step behavior. Trace how resource.properties and resource.parent.properties are passed through the workspace upgrade step to workspace-service, and confirm that main runs first. Done means the docs describe these flows accurately and no longer say the install step is unsupported.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.