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

Fully clean up quick start #95

Merged
merged 14 commits into from
Feb 1, 2022
Merged

Fully clean up quick start #95

merged 14 commits into from
Feb 1, 2022

Conversation

afilina
Copy link
Contributor

@afilina afilina commented Jan 27, 2022

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no
  • Remove a lot of filler text of type "he's what you're about to do" and "here's what you just did"
  • Choose more concise phrasing where possible
  • Introduce the page with a clear description of what we're about to build and the steps involved
  • Avoid euphemistic and exaggerating adjectives
  • Remove information about custom modules to lighten this guide; add a link to the modules tutorial instead
  • Since we no longer use custom modules, replace <module name> with Application to not leave devs to figure any of this out
  • There was some leftover info about the deprecated laminas-mvc-console
  • Say which file the code example belongs to in a uniform way
  • Replace "foo" and "bar" with something more meaningful
  • Add code comments to the controller example as opposed to post-example explanations
  • Add Learn More section with links

- Remove a lot of filler text of type "he's what you're about to do" and "here's what you just did"
- Choose more concise phrasing where possible
- Introduce the page with a clear description of what we're about to build and the steps involved
- Avoid euphemistic and exaggerating adjectives
- Remove information about custom modules to lighten this guide; add a link to the modules tutorial instead
- Since we no longer use custom modules, replace `<module name>` with `Application` to not leave devs to figure any of this out
- There was some leftover info about the deprecated laminas-mvc-console
- Say which file the code example belongs to in a uniform way
- Replace "foo" and "bar" with something more meaningful
- Add code comments to the controller example as opposed to post-example explanations
- Add Learn More section with links

Signed-off-by: Anna Filina <afilina@gmail.com>
@weierophinney weierophinney added this to the 3.3.1 milestone Jan 27, 2022
@weierophinney weierophinney added this to In progress in Documentation: improvements via automation Jan 27, 2022
Since this patch touches basically the whole file, I've applied the one-sentence-per-line rule everywheere.

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
@weierophinney
Copy link
Member

@froschdesign I'm happy with the changes; if they look good to you, please go ahead and merge.

docs/book/quick-start.md Outdated Show resolved Hide resolved
Copy link
Member

@froschdesign froschdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvement, exactly what we need! 👍

I added some comments with suggestions.

docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
Documentation: improvements automation moved this from In progress to Review in progress Jan 27, 2022
Copy link
Member

@Xerkus Xerkus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements.

docs/book/quick-start.md Outdated Show resolved Hide resolved
docs/book/quick-start.md Outdated Show resolved Hide resolved
afilina and others added 8 commits January 28, 2022 09:44
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>
Signed-off-by: Anna Filina <afilina@gmail.com>
docs/book/quick-start.md Outdated Show resolved Hide resolved
afilina and others added 2 commits January 28, 2022 10:11
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Anna Filina <afilina@gmail.com>
Signed-off-by: Anna Filina <afilina@gmail.com>

Co-authored-by: Aleksei Khudiakov <aleksey@xerkus.pro>
Signed-off-by: Anna Filina <afilina@gmail.com>
Documentation: improvements automation moved this from Review in progress to Reviewer approved Feb 1, 2022
@Xerkus Xerkus merged commit 3cce483 into laminas:3.3.x Feb 1, 2022
Documentation: improvements automation moved this from Reviewer approved to Done Feb 1, 2022
@afilina afilina deleted the quick-start branch February 2, 2022 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

5 participants