github/weave-scope
1
0
Fork 0
mirror of https://github.com/weaveworks/scope.git synced 2026-02-14 10:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs fixes

Browse Source 
- Make markdownlint happier
	- Fix some typos
	- Make it clear that meetings are currently on hold

Signed-off-by: Daniel Holbach <daniel@weave.works>
This commit is contained in:
Daniel Holbach
2021-07-13 12:16:16 +02:00
parent d436feb88c
commit 98dda9d4a9
5 changed files with 27 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@@ -7,7 +7,7 @@ it easier to get your contribution accepted.
We gratefully welcome improvements to documentation as well as to code.
# Certificate of Origin
## Certificate of Origin
By contributing to this project you agree to the Developer Certificate of
Origin (DCO). This document was created by the Linux Kernel community and is a
@@ -15,22 +15,23 @@ simple statement that you, as a contributor, have the legal right to make the
contribution. No action from you is required, but it's a good idea to see the
[DCO](DCO) file for details before you start contributing code to Scope.
# Email, Chat and Community Meetings
## Email, Chat and Community Meetings
The project uses the the scope-community email list and Slack:
- Email: [scope-community](https://groups.google.com/forum/#!forum/scope-community)
- 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
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.
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!
**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!
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
# Getting Started
## Getting Started
- Fork the repository on GitHub
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
- If you want to contribute as a developer, continue reading this document for further instructions
- Play with the project, submit bugs, submit pull requests!
@@ -43,7 +44,7 @@ This is a rough outline of how to prepare a contribution:
- Make sure your commit messages are in the proper format (see below).
- Push your changes to a topic branch in your fork of the repository.
- If you changed code:
- add automated tests to cover your changes
- add automated tests to cover your changes
- Submit a pull request to the original repository.
## How to build and run the project
@@ -80,15 +81,15 @@ Use `yarn` to run all Javascript tests and linting checks:
cd client && yarn install && yarn test && yarn lint
```
# Acceptance policy
## Acceptance policy
These things will make a PR more likely to be accepted:
* a well-described requirement
* tests for new code
* tests for old code!
* new code and tests follow the conventions in old code and tests
* a good commit message (see below)
- a well-described requirement
- tests for new code
- tests for old code!
- new code and tests follow the conventions in old code and tests
- a good commit message (see below)
In general, we will merge a PR once two maintainers have endorsed it.
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
questions: what changed and why. The subject line should feature the what and
the body of the commit should describe the why.
```
```txt
scripts: add the test-cluster command
this uses tmux to setup a test cluster that you can easily kill and
@@ -111,7 +112,7 @@ Fixes #38
The format can be described more formally as follows:
```
```txt
<subsystem>: <what changed>
<BLANK LINE>
<why this change was made>
@@ -128,7 +129,7 @@ git tools.
So you've built a Scope plugin. Where should it live?
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/).
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/).
If you have a good reason why the Scope maintainers should take custody of your
plugin, please open an issue so that it can potentially be promoted to the [Scope plugins](https://github.com/weaveworks-plugins/) organization.

13
README.md
View File

@@ -10,25 +10,25 @@
Weave Scope automatically generates a map of your application, enabling you to
intuitively understand, monitor, and control your containerized, microservices-based application.
### Understand your Docker containers in real time
## Understand your Docker containers in real time
<img src="imgs/topology.png" width="200" alt="Map you architecture" align="right">
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.
### Contextual details and deep linking
## Contextual details and deep linking
<img src="imgs/selected.png" width="200" alt="Focus on a single container" align="right">
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.
### Interact with and manage containers
## Interact with and manage containers
<img src="imgs/terminals.png" width="200" alt="Launch a command line." align="right">
Interact with your containers directly: pause, restart, and stop containers. Launch a command line. All without leaving the scope browser window.
### Extend and customize via plugins
## Extend and customize via plugins
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.
@@ -51,7 +51,7 @@ scope launch
```
This script downloads and runs a recent Scope image from Docker Hub.
Now, open your web browser to **http://localhost:4040**.
Now, open your web browser to **<http://localhost:4040>**.
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/).
@@ -71,7 +71,7 @@ If you have any questions, feedback, or problems with Scope:
- Send an email to [Scope community group](https://groups.google.com/forum/#!forum/scope-community)
- Meetings and events
- 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
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit)
- Join (and read up on) the regular [Scope community meetings](https://docs.google.com/document/d/103_60TuEkfkhz_h2krrPJH8QOx-vRnPpbcCZqrddE1s/edit) - currently on hold.
- Contributing
- Find out how to [contribute to Scope](CONTRIBUTING.md)
- [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!
We follow the [CNCF Code of Conduct](CODE-OF-CONDUCT.md).
## License
Scope is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
Find more details about the licenses of vendored code in [VENDORED_CODE.md](VENDORED_CODE.md).

2
site/building.md
View File

@@ -31,7 +31,7 @@ Scope unit tests for `probe` and `app` components can be run via:
make tests
Similarly the frontent client tests can be run via:
Similarly the frontend client tests can be run via:
make client-test

4
site/features.md
View File

@@ -4,7 +4,7 @@ menu_order: 15
search_type: Documentation
---
Browse the current feature set for Scope with links to relevant indepth topics:
Browse the current feature set for Scope with links to relevant in-depth topics:
* [Topology Mapping](#topology-mapping)
* [Views in Scope](#views)
@@ -24,7 +24,7 @@ Scope builds logical topologies of your application and infrastructure. A topol
## <a name="views"></a>Views in Scope
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.
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.
!['Kubernetes Views in Scope'](images/kubernetes-view.png)

2
site/installing.md
View File

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