From 972f488c915e4a388be923fec7490a42cdcae413 Mon Sep 17 00:00:00 2001 From: Federica Nocera Date: Thu, 11 Feb 2021 13:30:34 -0500 Subject: [PATCH] Fixed link in README and updated CONTRIBUTING (#517) * Fixed link in README * Updated CONTRIBUTING guide * Removed dead link --- CONTRIBUTING.md | 14 ++++++-------- README.md | 2 +- observability/tools/loki.md | 1 - 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 511946d332..19877e7a36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,6 +35,12 @@ to the project's Contributors group. Please contact one of the project's administrators to be added to the group. You will still need a PR against master in order to merge your changes. +## How to contribute + +When you have an idea for contribution open an *issue*! + +More details can be found in the internal CSE Wiki under the page `Contributing_to_the_Code-With_Engineering_Playbook`. + ## Git guidance Consistent with the practices suggested in this playbook, please follow the @@ -95,12 +101,6 @@ Each section consist of the following parts 1. Tool specific implementations of the concept 2. Named patterns or games that implement the concept (usually applies to agile ceremonies) -4. Case Studies - 1. Examples that illustrate how a team implemented the concept - 2. What problem was the team try to solve with their implementation? - 3. What worked well? - 4. Opportunities for improvement - 5. External Reference Material ### Example Directory Hierarchy @@ -120,8 +120,6 @@ The following illustrates how the directory structure could be organized. - ci-pipeline-for-dotnet-core.md - ci-pipeline-for-python.md - /jenkins - - /case-studies - - contoso-ci-pipeline-for-terraform.md ``` ## Legal Notices diff --git a/README.md b/README.md index b3420b520a..e90dce9d0b 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ A [breakdown of sections](SPRINT-STRUCTURE.md) according to the structure of an ## QuickLinks -* [Engineering Fundamentals Checklist](Engineering Fundamentals Checklist.md) +* [Engineering Fundamentals Checklist](ENG-FUNDAMENTALS-CHECKLIST.md) * [Structure of a Sprint](SPRINT-STRUCTURE.md) ## Engineering Fundamentals diff --git a/observability/tools/loki.md b/observability/tools/loki.md index 9741f0a0fa..c309416c13 100644 --- a/observability/tools/loki.md +++ b/observability/tools/loki.md @@ -36,4 +36,3 @@ of the log itself, using less space than just storing the raw logs. - [Inserting logs into Loki](https://grafana.com/docs/loki/latest/getting-started/get-logs-into-loki/) - [Adding Loki Source to Grafana](https://grafana.com/docs/grafana/latest/datasources/loki/#adding-the-data-source) - [Comparing Loki to other log systems](https://grafana.com/docs/loki/latest/overview/comparisons/) -- [Loki Best Practices](https://grafana.com/docs/loki/latest/best-practices/current-best-practices/)