Skip to content

Commit 742dfae

Browse files
committed
Update markdowns
1 parent 69b2d0f commit 742dfae

File tree

3 files changed

+35
-29
lines changed

3 files changed

+35
-29
lines changed

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
1-
# Project
1+
# Planetary Computer Examples
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
This repository contains Jupyter Notebooks that serve as examples of using the [Microsoft Planetary Computer](https://planetarycompture.microsoft.com) data, APIs and Hub.
54

6-
As the maintainer of this project, please make a few updates:
5+
## Getting Started
76

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
7+
This project uses Docker to encapsulate the development environment. To set up your development
8+
environment, have Docker installed and run:
9+
10+
```
11+
> scripts/setup
12+
```
13+
14+
If you need to rebuild the images at any point, you
15+
can run:
16+
17+
```
18+
> scripts/update
19+
```
20+
21+
To run the jupyter notebook server, you can use:
22+
23+
```
24+
> scripts/server
25+
```
26+
27+
And browse to the URL printed in the terminal output.
28+
29+
From there you'll be able to run all Jupyter Notebook examples.
1230

1331
## Contributing
1432

@@ -26,8 +44,8 @@ contact [[email protected]](mailto:[email protected]) with any additio
2644

2745
## Trademarks
2846

29-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
30-
trademarks or logos is subject to and must follow
47+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
48+
trademarks or logos is subject to and must follow
3149
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
3250
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
3351
Any use of third-party trademarks or logos are subject to those third-party's policies.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at
1414

1515
If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
1616

17-
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
17+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
1818

1919
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
2020

SUPPORT.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,13 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport).
7-
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
8-
9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
10-
111
# Support
122

13-
## How to file issues and get help
3+
## How to file issues and get help
144

15-
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
16-
issues before filing new issues to avoid duplicates. For new issues, file your bug or
5+
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
6+
issues before filing new issues to avoid duplicates. For new issues, file your bug or
177
feature request as a new Issue.
188

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
9+
For help and questions about using this project, please file a GitHub issue.
2210

23-
## Microsoft Support Policy
11+
## Microsoft Support Policy
2412

25-
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
13+
Support for the Planetary Computer Examples repository is limited to the resources listed above.

0 commit comments

Comments
 (0)