Skip to content

Commit 6fc6748

Browse files
Apply suggestions from code review
Co-authored-by: Sean Wheeler <[email protected]>
1 parent 885998c commit 6fc6748

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@ Cloud Shell team respects and enjoys engaging with our customers, please share o
2525
When you connect to Azure Cloud Shell, we start a container hosting a wide variety of tools, and
2626

2727
connect your browser to a shell process running inside that container. This repository contains the
28-
Docker files used to build that image. It does _not_ contain all of the code used for the rest of
28+
Docker files used to build that container image. It does _not_ contain the code used for the rest of
29+
2930
the Azure Cloud Shell service. The code in this repository may not match exactly to what is running
3031
in the Cloud Shell service at any given time. The service is updated periodically and changes are
31-
gradually rolled out to different regions over time, so there may be a lag of up to 3-4 weeks
32-
between a change being made here and being reflected in all Cloud Shell regions.
32+
gradually rolled out to different regions over time.
33+
There may be a lag of up to 3-4 weeks
34+
for changes made here to be reflected in all Cloud Shell regions.
3335

3436
This repository has several uses:
3537

@@ -41,11 +43,10 @@ This repository has several uses:
4143
Shell, you can create an issue or submit a Pull Request to request the tool be added. Please
4244
ensure that the PR actually builds within GitHub Actions.
4345

44-
The repository does *not* provide an out-of-the-box replacement for the Cloud Shell service. In
45-
addition to the container image here, Azure Cloud Shell consists of a user interface integrated into
46-
the portal, a web service which manages the infrastructure on which the containers run, and some
47-
additional code used inside the container to connect the shell process to the user interface via
48-
websocket.
46+
The repository does _not_ provide an out-of-the-box replacement for the Azure Cloud Shell service.
47+
Azure Cloud Shell provide a user interface integrated into the Azure portal, a web service that
48+
manages the infrastructure on which the containers run, and some additional code used inside the
49+
container to connect the shell process to the user interface via a websocket.
4950

5051
## Running the Cloud Shell image locally
5152

@@ -64,14 +65,14 @@ websocket.
6465

6566
### Understanding the base.Dockerfile and tools.Dockerfile
6667

67-
The repository contains two Dockerfile, 'base' and 'tools'. Tools is built on top of the base file,
68-
so normally you would just have one Dockerfile and rely on the container registry to cache all the
69-
layers that haven't changed. However we need to cache the base image explicitly to ensure fast
70-
startup time. So the image is split into these two files, and the tools layer starts FROM an
71-
internal repository where the base image is cached, so that we know when we need to update the base.
68+
The repository contains two Docker configuration files: `base` and `tools`. Normally you just have
69+
one Dockerfile and rely on the container registry to cache the layers that haven't changed.
70+
However, we need to cache the base image explicitly to ensure a fast startup time. Tools is built
71+
on top of the base file and starts from an internal repository where the base image is cached, so
72+
that we know when we need to update the base.
7273

7374
When building or using the image locally, you don't need to worry about that. Just build using the
74-
instructions below, and be aware that changes the the base layer will take longer to release than
75+
instructions below, and be aware that changes to the base layer will take longer to release than
7576
changes to the tools.
7677

7778
| Layer | Job |
@@ -116,9 +117,9 @@ Testing the Cloud Shell image
116117
docker run --volume /path/to/CloudShell/folder/tests:/tests -it tools_cloudshell /tests/test.sh
117118
```
118119

119-
For more information about bind mounts, please go onto the
120-
[Docker documentation](https://docs.docker.com/storage/bind-mounts/). We do expect all the test
121-
cases to pass if you would like your changes to be merged.
120+
For more information about bind mounts, please see the
121+
[Docker documentation](https://docs.docker.com/storage/bind-mounts/). We do expect all test cases
122+
to pass if you want your changes to be merged.
122123

123124
## Contribution Guidelines
124125

@@ -132,12 +133,14 @@ cases to pass if you would like your changes to be merged.
132133
| Issue with one of the packages* | Talk to package owner & create a PR on their repo. |
133134
| Issue with how package interacts with Cloud Shell | Create a Pull Request OR GitHub Issue |
134135
| Security bug | See https://www.microsoft.com/en-us/msrc/faqs-report-an-issue |
135-
| Issue with Cloud Shell in Azure Portal (can't log in, for example) | Open a [support ticket](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-troubleshooting-support-howto#:~:text=How%20to%20open%20a%20support%20ticket%20for%20Azure,Troubleshooting%20%2B%20Support%20and%20select%20New%20support%20request.) |
136+
| Issue with Cloud Shell in Azure Portal (can't log in, for example) | Open a [support ticket](https://learn.microsoft.com/azure/active-directory/fundamentals/how-to-get-support) |
137+
138+
139+
<sup>*</sup> For example, if you have an issue within Azure CLI, don't open up an issue in the Cloud Shell
140+
repo, open an issue within the Azure CLI repo.
136141

137-
\* For example, if you have an issue within Azure CLI, don't open up an issue with the Cloud Shell
138-
repo, open an issue within the Azure CLI repo. Azure PowerShell is
139-
[here](https://github.com/Azure/azure-powershell/issues) and Azure CLI is
140-
[here](https://github.com/Azure/azure-cli/issues)
142+
- [Azure PowerShell issues](https://github.com/Azure/azure-powershell/issues)
143+
- [Azure CLI issues](https://github.com/Azure/azure-cli/issues)
141144

142145
### Types of tools
143146

@@ -168,15 +171,17 @@ In general we avoid:
168171

169172
## Cloud Shell Documentation
170173

171-
Please see the [Microsoft Azure Documentation](https://github.com/MicrosoftDocs/azure-docs) for a
172-
guide to add to the Azure docs repo. The Cloud Shell documentation can be found
173-
[here](https://github.com/MicrosoftDocs/azure-docs/tree/master/articles/cloud-shell).
174+
The Cloud Shell documentation can be found at
175+
[https://learn.microsoft.com/azure/cloud-shell/overview](https://learn.microsoft.com/azure/cloud-shell/overview).
176+
If you wish to contribute to The Cloud Shell documentation, see the Microsoft Learn
177+
[Contributors Guide](https://learn.microsoft.com/contribute/).
174178

175179
## Legal
176180

177181
This project welcomes contributions and suggestions. Most contributions require you to agree to a
178182
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
179-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
183+
the rights to use your contribution. For details, see
184+
[https://cla.microsoft.com](https://cla.microsoft.com).
180185

181186
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
182187
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions

roadmap/cs-roadmap-2023.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@ through automation
88

99
## FY2023 roadmap
1010

11-
Azure Cloud Shell currently plans to release the following features and updates in the Sept-Oct 2023
11+
The Azure Cloud Shell team plans to release the following features and updates in the Sept-Oct 2023
1212
timeframe.
1313

14-
We plan to focus and achieve these goals:
15-
1614
- Increase active user satisfaction and adoption with improvement’s to UX
1715
- Decrease customer issues and increase adoption of VNET scenarios
1816
- Reduce resource consumption and improve security without persistent storage with Ephemeral
@@ -46,15 +44,14 @@ functionality of Cloud Shell. This will make it easier for users to navigate and
4644
resources they need. Benefits include:
4745

4846
- Improved user interface to be more modern and intuitive.
49-
- Accessibility improvements for users who may have disabilities or impairments by improving color
50-
contrast, adjusting font sizes and other accessibility improvements.
47+
- Update color contrast and font sizes to improve accessibility for user that may have vision impairments.
5148
- Support for enhanced functionality
5249

5350
### Ephemeral Sessions
5451

55-
Ephemeral sessions allow users to manage azure resources faster without the overhead of creating and
52+
Ephemeral sessions allow users to manage Azure resources faster without the overhead of creating and
5653
associating Azure storage accounts. These temporary and disposable sessions are best for scenarios
57-
where customers need to perform ad-hoc tasks without the need to persist and data or files between
54+
where customers need to perform ad-hoc tasks without the need to persist data or files between
5855
sessions. In addition, this provides a layer of security to scenarios to ensure that data or files
5956
created during the session are not accessible to other users or processes after the session ends.
6057

@@ -81,7 +78,8 @@ The VNET refresh will address these issues by making improvements:
8178

8279
## FY2024 Investments, Investigations and discussions
8380

84-
Working with customers, we are investigating and discussing future areas of imporvmeent and new features. These investigation are greatly impacted and enhanced with customer feedback. We welcome your feedback as we progress through these discussions by adding issues or discussions to our repository.
81+
We are working with customers to investigate and discuss areas of improvement and new features.
82+
We welcome your feedback. Please add issues or discussions to our repository.
8583

8684
- Multiple saved storage accounts
8785
- Multiple/Custom images

0 commit comments

Comments
 (0)