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

[shopsys] Start Building Your Application article #1201

Merged
merged 1 commit into from Jul 16, 2019

Conversation

@simara-svatopluk
Copy link
Contributor

simara-svatopluk commented Jul 12, 2019

Q A
Description, reason for the PR Implementator didn't know what to do after installation. Now we have a starting point explaining the most important steps and concepts
New feature No
BC breaks No
Fixes issues ...
Have you read and signed our License Agreement for contributions? Yes
@simara-svatopluk simara-svatopluk force-pushed the ss-project-start-documentation branch 9 times, most recently from da9da71 to 753abf6 Jul 12, 2019
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
@simara-svatopluk

This comment has been minimized.

Copy link
Contributor Author

simara-svatopluk commented Jul 12, 2019

@TomasLudvik So the structure of the article and the general approach is correct?

@TomasLudvik

This comment has been minimized.

Copy link
Member

TomasLudvik commented Jul 12, 2019

@TomasLudvik So the structure of the article and the general approach is correct?

Good question, I was just thinking about that. It would be probably better if you changed titles and a little descriptions in order to set user the right way.

It might be something like this:

  1. Commit your lock files
  2. Set your domains
  3. Set your locales ...

With short description why we suggest user to do that.

@simara-svatopluk

This comment has been minimized.

Copy link
Contributor Author

simara-svatopluk commented Jul 12, 2019

Sorry, I don't understand what do you suggest. So wheat do you suggest?

If you suggest numbered headlines, then I have an answer right away:
This article isn't cookbook, it is a list of useful tips that might help. Not steps implementator must do. That's why there aren't numbers in headlines.

@TomasLudvik

This comment has been minimized.

Copy link
Member

TomasLudvik commented Jul 15, 2019

Sorry, I don't understand what do you suggest. So wheat do you suggest?

If you suggest numbered headlines, then I have an answer right away:
This article isn't cookbook, it is a list of useful tips that might help. Not steps implementator must do. That's why there aren't numbers in headlines.

I am so sorry that I forgot it during first review and I did not prioritize this, but main reason for this article is to say to people: "Hey guys, you need to do this five steps because they are important"

Your style is "how to do something" and it should be "do this and this because ...".

@simara-svatopluk simara-svatopluk force-pushed the ss-project-start-documentation branch from 07cc056 to 7c5eed7 Jul 16, 2019
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
- explains what to do after the SSFW is installed
Copy link
Contributor

vitek-rostislav left a comment

Hi @simara-svatopluk, nice job 👌

@TomasLudvik, we discussed your argument and finally, we agreed that it will be written the more imperative way 🙂

simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
Copy link
Contributor

LukasHeinz left a comment

Well done. I have only 2 suggestions.

docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
docs/introduction/start-building-your-application.md Outdated Show resolved Hide resolved
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
Co-Authored-By: Lukáš Heinz <lukas.heinz@shopsys.com>
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
Co-Authored-By: Lukáš Heinz <lukas.heinz@shopsys.com>
@simara-svatopluk simara-svatopluk force-pushed the ss-project-start-documentation branch from 6410a88 to 7fd963c Jul 16, 2019
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
- explains what to do after the SSFW is installed
@simara-svatopluk simara-svatopluk force-pushed the ss-project-start-documentation branch from 7fd963c to f5817cc Jul 16, 2019
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
- explains what to do after the SSFW is installed
simara-svatopluk added a commit that referenced this pull request Jul 16, 2019
- explains what to do after the SSFW is installed
@simara-svatopluk simara-svatopluk force-pushed the ss-project-start-documentation branch from fbe5e56 to 136727d Jul 16, 2019
@simara-svatopluk simara-svatopluk merged commit 136727d into master Jul 16, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@simara-svatopluk simara-svatopluk deleted the ss-project-start-documentation branch Jul 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.