Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Machines - Code - People: 50 things Zühlke engineers are passionate about
# Machines, Code, People: 50 things Zühlke engineers are passionate about

This is the repository for the book *Machines, Code, People*. You can read the book at [https://zuehlke.github.io/machines-code-people/](https://zuehlke.github.io/machines-code-people/) or order a copy on [Amazon](https://www.amazon.de/Machines-Code-People-engineers-passionate/dp/3748141181). Enjoy!

## Vision

Expand All @@ -8,22 +10,6 @@ We write for all engineers at Zühlke and outside of Zühlke - from professional

Through our articles, the Zühlke culture manifests itself: they contain practicaly proven concepts, best practices, cultural philosophies and great ideas, they are technically interesting, they motivate you to reflect about the work and they encourage you to share your knowlege and experiences.

## How to contribute

1. Announce an article by opening an [issue in our backlog](https://github.com/Zuehlke/fifty-shades/issues/new?labels=article&title=Article:%20%3Cput%20topic%20title%20here%3E)

2. Write the article

3. Get it reviewed and published

Follow one of our two contribution guidelines to contribute your article:

* The [GitHub Contribution Guidelines](./github-contribution-guideline.md) is the default choice. It ensures a seamless process using Git and GitHub tooling.

* The [General Contribution Guideline](./general-contribution-guideline.md) is for those who are new to GitHub and prefer to work independently from GitHub as much as possible.

For additional questions, we created a page about [advanced contribution topics](./advanced-contribution-topics.md).

## Licence

All content is licensed under the [Creative Commons Attribution Non Commercial Share Alike 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) license.
2 changes: 1 addition & 1 deletion admin/getIssues.ps1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# $issues = Invoke-RestMethod -Uri http://api.github.com/repos/Zuehlke/fifty-shades/issues?labels=article&per_page=100 -Method Get
# $issues = Invoke-RestMethod -Uri http://api.github.com/repos/Zuehlke/machines-code-people/issues?labels=article&per_page=100 -Method Get
$issues = Get-Content -Raw -Path issues.json | ConvertFrom-Json
foreach ($issue in $issues) {
$id = $issue.number
Expand Down
1,006 changes: 503 additions & 503 deletions admin/issues.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion advanced-contribution-topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To provide resources like links or books:
{% endraw %}
```

Please note: This is a temporary solution. In the future we'd like to auto-detect resources and include them in different ways based on the output. For an electronic format (web, pdf, ebook) the resources are just included. For a printed format (book) the resources might be printed as a QR-Code linking to a website. For more information see https://github.com/Zuehlke/fifty-shades/issues/18
Please note: This is a temporary solution. In the future we'd like to auto-detect resources and include them in different ways based on the output. For an electronic format (web, pdf, ebook) the resources are just included. For a printed format (book) the resources might be printed as a QR-Code linking to a website. For more information see https://github.com/Zuehlke/machines-code-people/issues/18

## Zühlke Github Community

Expand Down
2 changes: 1 addition & 1 deletion articles/_example.resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

### Links

* [Fifty-Shades](https://github.com/Zuehlke/fifty-shades/) repository contains our source code.
* [Machines, Code, People](https://github.com/Zuehlke/machines-code-people/) repository contains our source code.
2 changes: 1 addition & 1 deletion articles/transition-system-engineering.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Transitioning systems engineering into the lean-agile world

## At the top management level, agile is a means not a goal

The customer has been very successful in the past two decades in defining quality standards in the industry and growing healthily by pursuing geographic expansion. As is often the case, success brings complacency and in this case insights into the real needs of different customers and the predictability of project outcomes and timelines needed improving. Just making the product 10% more accurate or faster no longer created sufficient customer value. The technical limits of improving product performance had been reached. Breaking through these them made the products excessively expensive and the development effort unpredictable. Agile, with its focus on customer value, early customer feedback cycles and delivering working prototypes with a short cadence promised to be a suitable remedy to many of the weaknesses in the organisation. Launching products that excite customers and users in a regular and predictable tempo was required to secure the future growth and success of the company. When transitioning to agile, we always have to steer the transformation based on such overall goals of our customer.
The customer has been very successful in the past two decades in defining quality standards in the industry and growing healthily by pursuing geographic expansion. As is often the case, success brings complacency and in this case insights into the real needs of different customers and the predictability of project outcomes and timelines needed improving. Just making the product 10% more accurate or faster no longer created sufficient customer value. The technical limits of improving product performance had been reached. Breaking through these made the products excessively expensive and the development effort unpredictable. Agile, with its focus on customer value, early customer feedback cycles and delivering working prototypes with a short cadence promised to be a suitable remedy to many of the weaknesses in the organisation. Launching products that excite customers and users in a regular and predictable tempo was required to secure the future growth and success of the company. When transitioning to agile, we always have to steer the transformation based on such overall goals of our customer.

## To start, organisation beats process: What’s in it for me?

Expand Down
2 changes: 1 addition & 1 deletion book.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"author": "Christian Abegg, Peter Gfader",
"pluginsConfig": {
"github": {
"url": "https://github.com/zuehlke/fifty-shades"
"url": "https://github.com/zuehlke/machines-code-people"
},
"onlineresources": {
"url": "https://zuehlke.github.io/machines-code-people/",
Expand Down
8 changes: 4 additions & 4 deletions general-contribution-guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ This guide describes the process and the conventions for contributing an article

1. **Check for Duplicates:** Is there already an article about your topic?

* Please check our [Backlog of Articles](https://github.com/Zuehlke/fifty-shades/issues?q=is%3Aissue+label%3Aarticle) whether there is already an article existing or planned for similar topic. You need a GitHub account for this.
* Please check our [Backlog of Articles](https://github.com/Zuehlke/machines-code-people/issues?q=is%3Aissue+label%3Aarticle) whether there is already an article existing or planned for similar topic. You need a GitHub account for this.

* If there is already a similar article, you can contact the author and find a solution (leave the subject to the author, offer your help as reviewer or co-author, take the subject over, or write a second article in response or extension to the first article, ...).

2. **Announce an Article:**

* Open a [New Issue for your Article](https://github.com/Zuehlke/fifty-shades/issues/new?labels=article&title=Article:%20%3Cput%20topic%20title%20here%3E)
* Open a [New Issue for your Article](https://github.com/Zuehlke/machines-code-people/issues/new?labels=article&title=Article:%20%3Cput%20topic%20title%20here%3E)

* Describe roughly the idea you have in mind, what the article should be about.

Expand All @@ -22,7 +22,7 @@ It proved to be useful to discuss about an articles content before writing the a

To discuss about an articles content, you have various options:

* Use the [Issues on Github](https://github.com/Zuehlke/fifty-shades/issues): discuss directly in the issue you created - and don't miss to give feedback to other announced articles.
* Use the [Issues on Github](https://github.com/Zuehlke/machines-code-people/issues): discuss directly in the issue you created - and don't miss to give feedback to other announced articles.

* Use Yammer, a coffee break, a team event or similar

Expand Down Expand Up @@ -56,7 +56,7 @@ To discuss about an articles content, you have various options:

* Formatted using the [Markdown Syntax](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

The [Example Article](https://raw.githubusercontent.com/Zuehlke/fifty-shades/develop/articles/_example.md) is a good starting point.
The [Example Article](https://raw.githubusercontent.com/Zuehlke/machines-code-people/develop/articles/_example.md) is a good starting point.

## Peer Review

Expand Down
16 changes: 8 additions & 8 deletions github-contribution-guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ This guide describes the process and the conventions for contributing an article

1. **Check for Duplicates:** Is there already an article about your topic?

* Please check our [Backlog of Articles](https://github.com/Zuehlke/fifty-shades/issues?q=is%3Aissue+label%3Aarticle) whether there is already an article existing or planned for similar topic.
* Please check our [Backlog of Articles](https://github.com/Zuehlke/machines-code-people/issues?q=is%3Aissue+label%3Aarticle) whether there is already an article existing or planned for similar topic.

* If there is already a similar article, you can contact the author and find a solution (leave the subject to the author, offer your help as reviewer or co-author, take the subject over, or write a second article in response or extension to the first article, ...).

2. **Announce a Topic:**

* Open a [New Issue for your Article](https://github.com/Zuehlke/fifty-shades/issues/new?labels=article&title=Article:%20%3Cput%20topic%20title%20here%3E)
* Open a [New Issue for your Article](https://github.com/Zuehlke/machines-code-people/issues/new?labels=article&title=Article:%20%3Cput%20topic%20title%20here%3E)

* Describe roughly the idea you have in mind, what the article should be about.

## Discuss

It proved to be useful to discuss about an articles content before writing the article. Ask your colleagues, maybe they have some valuable input!

* Use the [Issues on Github](https://github.com/Zuehlke/fifty-shades/issues): discuss directly in the issue you created - and don't miss to give feedback to other announced articles.
* Use the [Issues on Github](https://github.com/Zuehlke/machines-code-people/issues): discuss directly in the issue you created - and don't miss to give feedback to other announced articles.

* Use Yammer, a coffee break, a team event or similar

Expand Down Expand Up @@ -60,14 +60,14 @@ We are using this Git repository, so contributing an article is as easy as contr

If this sounds complicated to you, just carefully follow these very easy steps to create a new article directly on the github web page:

1. Use this link to [fork the Zuehlke/fifty-shades repository](https://github.com/Zuehlke/fifty-shades/fork).
1. Use this link to [fork the Zuehlke/machines-code-people repository](https://github.com/Zuehlke/machines-code-people/fork).

2. Navigate to the `articles` folder in your forked repository. The URL looks something like:
https://github.com/{username}/fifty-shades/tree/develop/articles
https://github.com/{username}/machines-code-people/tree/develop/articles

3. Enter a unique name for your article file followed by the *.md file extension. Example: `my-funny-article.md` (can be changed later)

4. Copy the content of [Article Example as template to start with](https://raw.githubusercontent.com/Zuehlke/fifty-shades/develop/articles/_example.md) into the file
4. Copy the content of [Article Example as template to start with](https://raw.githubusercontent.com/Zuehlke/machines-code-people/develop/articles/_example.md) into the file

5. Adjust `authorName` and `authorGithubUsername` at the top of the file

Expand All @@ -91,7 +91,7 @@ If you'd like to use the review features of Github you can open a pull request a

1. Open a pull request with your article to get it reviewed.

Look out for the "New Pull Request" button. The base fork is "Zuehlke/fifty-shades" and the head fork is "{you}/fifty-shades".
Look out for the "New Pull Request" button. The base fork is "Zuehlke/machines-code-people" and the head fork is "{you}/machines-code-people".

Use the issue number of your article prefixed with `#`in the pull request title

Expand All @@ -108,7 +108,7 @@ When the article is ready to be published, ask a lead author for a review.

1. If you do not already have a pull request, create a pull request with your article to get it reviewed

Look out for the "New Pull Request" button. The base fork is "Zuehlke/fifty-shades" and the head fork is "{you}/fifty-shades".
Look out for the "New Pull Request" button. The base fork is "Zuehlke/machines-code-people" and the head fork is "{you}/machines-code-people".

Use the issue number of your article prefixed with `#`in the pull request title

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "fifty-shades",
"name": "machines-code-people",
"scripts": {
"start": "gitbook install && gitbook serve",
"build": "gitbook install && gitbook build",
Expand Down
Loading