Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update build-matrix_5c062ead04286304a71cf455.md #349

Merged
merged 3 commits into from Apr 9, 2019
Merged

Update build-matrix_5c062ead04286304a71cf455.md #349

merged 3 commits into from Apr 9, 2019

Conversation

TomFern
Copy link
Collaborator

@TomFern TomFern commented Apr 5, 2019

Proposed build matrix reference with examples

Proposed build matrix reference with examples
@markoa
Copy link
Contributor

markoa commented Apr 5, 2019

@TomFern Overall good first take but I'm sorry for not being clear in my initial instructions. The C and Java projects are let's say production examples which also contain some details that are not necessary for understanding the basics of how build matrix works on Semaphore. They make it harder, actually.

When reading the docs, users are usually in the middle of solving a concrete problem and generally speaking in a hurry. In a docs page that is not a "full-stack" tutorial, people want something they can copy & paste. So:

  • Use as little words as possible to explain what you need.
  • Simplest language.
  • Simplest code snippets as possible, with zero noise.

So with that I think you need to rethink this page almost from scratch.

Some suggestions:

  • Intro seems OK to me, probably not much editing is necessary.
  • Let's have two examples, one with env vars and another which shows "Testing against multiple language versions". Let's pick Java for that, but write a minimal yml from scratch in which you set-version and then run java -version. Readers should know how to expand further for their project.
  • Please run the YMLs that you write about on Semaphore yourself. You will then see that eg "the job will have been executed 9 times" is not correct, but that Semaphore runs 9 parallel jobs.

@TomFern
Copy link
Collaborator Author

TomFern commented Apr 5, 2019

@markoa thanks for the feedback. I'll rework doc and make the corrections.

new version, less words, two examples, cleaner text
@markoa
Copy link
Contributor

markoa commented Apr 9, 2019

Thanks, I think this is good to go for the first pass. We'll adjust further based on user feedback.

@markoa markoa merged commit eddb9f4 into semaphoreci:master Apr 9, 2019
@TomFern TomFern deleted the patch-2 branch April 15, 2019 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants