Skip to content

Commit 1ba2640

Browse files
authored
Rebrand playbook as 'Engineering Fundamentals' (microsoft#1029)
* Rebrand playbook as 'Engineering Fundamentals'. Also fix a few typos and broken links. * WeaveWorks out of business and link broke. Replaced with link to GitLab * Add https://www.gartner.com/en/information-technology/glossary/citizen-developer to exclusion list
1 parent 7f2dab8 commit 1ba2640

File tree

11 files changed

+16
-15
lines changed

11 files changed

+16
-15
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ISE Code-With Customer/Partner Engineering Playbook
1+
# ISE Engineering Fundamentals Customer/Partner Engineering Playbook
22

33
An engineer or data scientist working on an [ISE](docs/ISE.md) project...
44

docs/ISE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Who We Are
22

3-
Our team, ISE (Industry Solutions Engineering), works side by side with customers to help them tackle their toughest technical problems both in the cloud and on the edge. We meet customers where they are, work in the languages they use, with the open source frameworks they use, on the operating systems they use. We work with enterprises and start-ups across many industries from financial services to manufacturing. Our work covers a broad spectrum of domains including IoT, machine learning, and high scale compute. Our "superpower" is that we work closely with both our customers’ engineering teams and Microsoft’s product engineering teams, developing real-world expertise that we can use to help our customers grow their business and help Microsoft improve our products and services.
3+
Our team, ISE (Industry Solutions Engineering), works side-by-side with customers to help them tackle their toughest technical problems both in the cloud and on the edge. We meet customers where they are, work in the languages they use, with the open source frameworks they use, and on the operating systems they use. We work with enterprises and start-ups across many industries from financial services to manufacturing. Our work covers a broad spectrum of domains including IoT, machine learning, and high scale compute. Our "superpower" is that we work closely with both our customers’ engineering teams and Microsoft’s product engineering teams, developing real-world expertise that we can use to help our customers grow their business and help Microsoft improve our products and services.
44

55
We are very community focused in our work, with one foot in Microsoft and one foot in the open source communities that we help. We make pull requests on open source projects to add support for Microsoft platforms and/or improve existing implementations. We build frameworks and other tools to make it easier for developers to use Microsoft platforms. We source all the ideas for this work by maintaining very deep connections with these communities and the customers and partners that use them.
66

docs/agile-development/advanced-topics/team-agreements/working-agreements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ their own, and adjust times, communication channels, branch naming policies etc.
3333
## Quality and not Quantity
3434

3535
- We agree on a [Definition of Done](definition-of-done.md) for our user story's and sprints and live by it.
36-
- We follow engineering best practices like the [Code With Engineering Playbook](https://github.com/microsoft/code-with-engineering-playbook)
36+
- We follow engineering best practices like the [Engineering Fundamentals Engineering Playbook](https://github.com/microsoft/code-with-engineering-playbook)
3737

3838
## Scrum Rhythm
3939

@@ -77,7 +77,7 @@ The Process Lead is responsible for leading any scrum or agile practices to enab
7777

7878
- We follow the git flow branch naming convention for branches and identify the task number e.g. `feature/123-add-working-agreement`
7979
- We merge all code into main branches through PRs
80-
- All PRs are reviewed by one person from [Customer/Partner Name] and one from Microsoft (for knowledge transfer and to ensure code and security standards are met)
80+
- All PRs are reviewed by one person from <Customer/Partner Name> and one from Microsoft (for knowledge transfer and to ensure code and security standards are met)
8181
- We always review existing PRs before starting work on a new task
8282
- We look through open PRs at the end of stand-up to make sure all PRs have reviewers.
8383
- We treat documentation as code and apply the same [standards to Markdown](../../../code-reviews/recipes/markdown.md) as code

docs/code-reviews/pull-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ See also [Pull Request Template](./pull-request-template.md)
8282

8383
## Resources
8484

85-
* [Writing a great pull request description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description)
86-
* [Review code with pull requests (Azure DevOps)](https://learn.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops)
85+
* [Writing a great pull request description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description/)
86+
* [Review code-with pull requests (Azure DevOps)](https://learn.microsoft.com/azure/devops/repos/git/pull-requests)
8787
* [Collaborating with issues and pull requests (GitHub)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)
8888
* [Google approach to PR size](https://google.github.io/eng-practices/review/developer/small-cls.html)
8989
* [Feature Flags](https://www.martinfowler.com/articles/feature-toggles.html)

docs/continuous-delivery/gitops/deploying/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is GitOps?
44

5-
GitOps is a way of managing your infrastructure and applications so that the whole system is described declaratively and version controlled (most likely in a Git repository), and having an automated process that ensures that the deployed environment matches the state specified in a repository."- [WeaveWorks](https://www.weave.works/technologies/gitops/#what-is-gitops)
5+
"GitOps is an operational framework that takes DevOps best practices used for application development such as version control, collaboration, compliance, and CI/CD, and applies them to infrastructure automation." See [GitLab: What is GitOps?](https://about.gitlab.com/topics/gitops/).
66

77
## Why should I use GitOps?
88

docs/continuous-integration/markdown-linting/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ To start using this pipeline:
3535

3636
## References
3737

38-
[Markdown Code Reviews in the Code With Engineering Playbook](https://microsoft.github.io/code-with-engineering-playbook/code-reviews/recipes/markdown/#code-review-checklist)
38+
[Markdown Code Reviews in the Engineering Fundamentals Playbook](https://microsoft.github.io/code-with-engineering-playbook/code-reviews/recipes/markdown/#code-review-checklist)

docs/design/design-reviews/recipes/async-design-reviews.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ This in turn results in the following benefits:
1313

1414
## Measures
1515

16-
The metrics and/or KPIs used for design reviews overall would still apply. See [design reviews](../README.md#Measures) for measures guidance.
16+
The metrics and/or KPIs used for design reviews overall would still apply. See [design reviews](../README.md#measures) for measures guidance.
1717

1818
## Participation
1919

20-
The participation should be same as any design review. See [design reviews](../README.md#Participation) for participation guidance.
20+
The participation should be same as any design review. See [design reviews](../README.md#participation) for participation guidance.
2121

2222
## Facilitation Guidance
2323

docs/documentation/recipes/static-website-with-mkdocs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[MkDocs](https://www.mkdocs.org/) is a tool built to create static websites from raw markdown files. Other alternatives include [Sphinx](https://www.sphinx-doc.org/en/master/), and [Jekyll](https://jekyllrb.com/).
44

5-
We used MkDocs to create [ISE Code-With Engineering Playbook](https://microsoft.github.io/code-with-engineering-playbook/) static website from the contents in [the GitHub repository](https://github.com/microsoft/code-with-engineering-playbook). Then we deployed it to [GitHub Pages](https://pages.github.com/).
5+
We used MkDocs to create [ISE Engineering Fundamentals Playbook](https://microsoft.github.io/code-with-engineering-playbook/) static website from the contents in [the GitHub repository](https://github.com/microsoft/code-with-engineering-playbook). Then we deployed it to [GitHub Pages](https://pages.github.com/).
66

77
We found MkDocs to be a good choice since:
88

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ISE Code-With Engineering Playbook
1+
# ISE Engineering Fundamentals Playbook
22

33
An engineer working for a [ISE](ISE.md) project...
44

linkcheck.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@
6262
"https://lldb.llvm.org/",
6363
"https://www.microsoft.com/",
6464
"https://aka.ms/opensource/security/",
65-
"https://www.pluralsight.com/courses/"
65+
"https://www.pluralsight.com/courses/",
66+
"https://www.gartner.com/en/information-technology/glossary/citizen-developer"
6667
],
6768
"only_errors": true,
6869
"cache_duration": "24h",

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
site_name: Code With Engineering Playbook
2+
site_name: Engineering Fundamentals Playbook
33
site_url: https://microsoft.github.io/code-with-engineering-playbook
4-
site_description: ISE Code With Engineering Playbook
4+
site_description: ISE Engineering Fundamentals Engineering Playbook
55
site_author: Microsoft ISE
66

77
repo_url: https://github.com/microsoft/code-with-engineering-playbook/

0 commit comments

Comments
 (0)