Skip to content

Commit 98dda9d

Browse files
author
Daniel Holbach
committed
Docs fixes
- Make markdownlint happier - Fix some typos - Make it clear that meetings are currently on hold Signed-off-by: Daniel Holbach <[email protected]>
1 parent d436feb commit 98dda9d

File tree

5 files changed

+27
-25
lines changed

5 files changed

+27
-25
lines changed

CONTRIBUTING.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,31 @@ it easier to get your contribution accepted.
77

88
We gratefully welcome improvements to documentation as well as to code.
99

10-
# Certificate of Origin
10+
## Certificate of Origin
1111

1212
By contributing to this project you agree to the Developer Certificate of
1313
Origin (DCO). This document was created by the Linux Kernel community and is a
1414
simple statement that you, as a contributor, have the legal right to make the
1515
contribution. No action from you is required, but it's a good idea to see the
1616
[DCO](DCO) file for details before you start contributing code to Scope.
1717

18-
# Email, Chat and Community Meetings
18+
## Email, Chat and Community Meetings
1919

2020
The project uses the the scope-community email list and Slack:
21+
2122
- Email: [scope-community](https://groups.google.com/forum/#!forum/scope-community)
2223
- Chat: Join the [Weave community](https://weaveworks.github.io/community-slack/) Slack workspace and use the [#scope](https://weave-community.slack.com/messages/scope/) channel
2324

2425
When sending email, it's usually best to use the mailing list. The maintainers are usually quite busy and the mailing list will more easily find somebody who can reply quickly. You will also be potentially be helping others who had the same question.
2526

26-
We also meet regularly at the [Scope community meeting](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/). Don't feel discouraged to attend the meeting due to not being a developer. Everybody is welcome!
27+
**Currently on hold**: We also meet regularly at the [Scope community meeting](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/). Don't feel discouraged to attend the meeting due to not being a developer. Everybody is welcome!
2728

2829
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
2930

30-
# Getting Started
31+
## Getting Started
3132

3233
- Fork the repository on GitHub
33-
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
34+
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
3435
- If you want to contribute as a developer, continue reading this document for further instructions
3536
- Play with the project, submit bugs, submit pull requests!
3637

@@ -43,7 +44,7 @@ This is a rough outline of how to prepare a contribution:
4344
- Make sure your commit messages are in the proper format (see below).
4445
- Push your changes to a topic branch in your fork of the repository.
4546
- If you changed code:
46-
- add automated tests to cover your changes
47+
- add automated tests to cover your changes
4748
- Submit a pull request to the original repository.
4849

4950
## How to build and run the project
@@ -80,15 +81,15 @@ Use `yarn` to run all Javascript tests and linting checks:
8081
cd client && yarn install && yarn test && yarn lint
8182
```
8283

83-
# Acceptance policy
84+
## Acceptance policy
8485

8586
These things will make a PR more likely to be accepted:
8687

87-
* a well-described requirement
88-
* tests for new code
89-
* tests for old code!
90-
* new code and tests follow the conventions in old code and tests
91-
* a good commit message (see below)
88+
- a well-described requirement
89+
- tests for new code
90+
- tests for old code!
91+
- new code and tests follow the conventions in old code and tests
92+
- a good commit message (see below)
9293

9394
In general, we will merge a PR once two maintainers have endorsed it.
9495
Trivial changes (e.g., corrections to spelling) may get waved through.
@@ -100,7 +101,7 @@ We follow a rough convention for commit messages that is designed to answer two
100101
questions: what changed and why. The subject line should feature the what and
101102
the body of the commit should describe the why.
102103

103-
```
104+
```txt
104105
scripts: add the test-cluster command
105106
106107
this uses tmux to setup a test cluster that you can easily kill and
@@ -111,7 +112,7 @@ Fixes #38
111112

112113
The format can be described more formally as follows:
113114

114-
```
115+
```txt
115116
<subsystem>: <what changed>
116117
<BLANK LINE>
117118
<why this change was made>
@@ -128,7 +129,7 @@ git tools.
128129

129130
So you've built a Scope plugin. Where should it live?
130131

131-
Until it matures, it should live in your own repo. You are encouraged to annouce your plugin at the [mailing list](https://groups.google.com/forum/#!forum/scope-community) and to demo it at a [community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/).
132+
Until it matures, it should live in your own repo. You are encouraged to announce your plugin at the [mailing list](https://groups.google.com/forum/#!forum/scope-community) and to demo it at a [community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/).
132133

133134
If you have a good reason why the Scope maintainers should take custody of your
134135
plugin, please open an issue so that it can potentially be promoted to the [Scope plugins](https://github.com/weaveworks-plugins/) organization.

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@
1010
Weave Scope automatically generates a map of your application, enabling you to
1111
intuitively understand, monitor, and control your containerized, microservices-based application.
1212

13-
### Understand your Docker containers in real time
13+
## Understand your Docker containers in real time
1414

1515
<img src="imgs/topology.png" width="200" alt="Map you architecture" align="right">
1616

1717
Choose an overview of your container infrastructure, or focus on a specific microservice. Easily identify and correct issues to ensure the stability and performance of your containerized applications.
1818

19-
### Contextual details and deep linking
19+
## Contextual details and deep linking
2020

2121
<img src="imgs/selected.png" width="200" alt="Focus on a single container" align="right">
2222

2323
View contextual metrics, tags, and metadata for your containers. Effortlessly navigate between processes inside your container to hosts your containers run on, arranged in expandable, sortable tables. Easily find the container using the most CPU or memory for a given host or service.
2424

25-
### Interact with and manage containers
25+
## Interact with and manage containers
2626

2727
<img src="imgs/terminals.png" width="200" alt="Launch a command line." align="right">
2828

2929
Interact with your containers directly: pause, restart, and stop containers. Launch a command line. All without leaving the scope browser window.
3030

31-
### Extend and customize via plugins
31+
## Extend and customize via plugins
3232

3333
Add custom details or interactions for your hosts, containers, and/or processes by creating Scope plugins. Or, just choose from some that others have already written at the GitHub [Weaveworks Scope Plugins](https://github.com/weaveworks-plugins/) organization.
3434

@@ -51,7 +51,7 @@ scope launch
5151
```
5252

5353
This script downloads and runs a recent Scope image from Docker Hub.
54-
Now, open your web browser to **http://localhost:4040**.
54+
Now, open your web browser to **<http://localhost:4040>**.
5555

5656
For instructions on installing Scope on [Kubernetes](https://www.weave.works/docs/scope/latest/installing/#k8s), [DCOS](https://www.weave.works/docs/scope/latest/installing/#dcos), or [ECS](https://www.weave.works/docs/scope/latest/installing/#ecs), see [the docs](https://www.weave.works/docs/scope/latest/introducing/).
5757

@@ -71,7 +71,7 @@ If you have any questions, feedback, or problems with Scope:
7171
- Send an email to [Scope community group](https://groups.google.com/forum/#!forum/scope-community)
7272
- Meetings and events
7373
- Join the [Weave User Group](https://www.meetup.com/pro/Weave/) and get invited to online talks, hands-on training and meetups in your area
74-
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit)
74+
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit) - currently on hold.
7575
- Contributing
7676
- Find out how to [contribute to Scope](CONTRIBUTING.md)
7777
- [File an issue](https://github.com/weaveworks/scope/issues/new) or make a pull request for one of our [good first issues](https://github.com/weaveworks/scope/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-issue)
@@ -81,5 +81,6 @@ Your feedback is always welcome!
8181
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
8282

8383
## License
84+
8485
Scope is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
8586
Find more details about the licenses of vendored code in [VENDORED_CODE.md](VENDORED_CODE.md).

site/building.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Scope unit tests for `probe` and `app` components can be run via:
3131

3232
make tests
3333

34-
Similarly the frontent client tests can be run via:
34+
Similarly the frontend client tests can be run via:
3535

3636
make client-test
3737

site/features.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ menu_order: 15
44
search_type: Documentation
55
---
66

7-
Browse the current feature set for Scope with links to relevant indepth topics:
7+
Browse the current feature set for Scope with links to relevant in-depth topics:
88

99
* [Topology Mapping](#topology-mapping)
1010
* [Views in Scope](#views)
@@ -24,7 +24,7 @@ Scope builds logical topologies of your application and infrastructure. A topol
2424

2525
## <a name="views"></a>Views in Scope
2626

27-
Views in Scope can be thought of as high-level filters on your containerized microservices as they run in the cloud. They are categorized into: Processes, Containers, Orchestrators, and Hosts. The Orchestrator view is context-sensitive, and as a result, if an app is running in Kubernetes, then Scope displays Pods, Replica Sets, Deployments, and Services that allow you to drilldown on Kubernetes clusters.
27+
Views in Scope can be thought of as high-level filters on your containerized microservices as they run in the cloud. They are categorized into: Processes, Containers, Orchestrators, and Hosts. The Orchestrator view is context-sensitive, and as a result, if an app is running in Kubernetes, then Scope displays Pods, Replica Sets, Deployments, and Services that allow you to drill down on Kubernetes clusters.
2828

2929
!['Kubernetes Views in Scope'](images/kubernetes-view.png)
3030

site/installing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Next, create a dedicated project for Weave Scope then apply policy changes neede
213213
oc new-project weave
214214
# Scope probe pods need full access to Kubernetes API via 'weave-scope' service account
215215
oc adm policy add-cluster-role-to-user cluster-admin -z weave-scope
216-
# Scope probe pods also need to run as priviliaged containers, so grant 'priviliged' Security Context Constrains (SCC) for 'weave-scope' service account
216+
# Scope probe pods also need to run as privileged containers, so grant 'privileged' Security Context Constrains (SCC) for 'weave-scope' service account
217217
oc adm policy add-scc-to-user privileged -z weave-scope
218218
# Scope app has an init daemon that has to run as UID 0, so grant 'anyuid' SCC for 'default' service account
219219
oc adm policy add-scc-to-user anyuid -z default

0 commit comments

Comments
 (0)