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

docs: reorganize installation instructions into individual pages for each module #1523

Merged
merged 5 commits into from
Jan 25, 2019
Merged

docs: reorganize installation instructions into individual pages for each module #1523

merged 5 commits into from
Jan 25, 2019

Conversation

wesleygrimes
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Missing documentation on use of ng add

What is the new behavior?

Added a new section to the https://ngrx.io/guide/store that documents how to use the ng add commands for NgRx.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Cross-reference #1146

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jan 23, 2019

Preview docs changes for b487127 at https://previews.ngrx.io/pr1523-b487127/

@wesleygrimes
Copy link
Contributor Author

Just realized I missed some of the other ng add options. As I think about this more, how about I split this up and add a section to the each of the main doc sections for ng add. So under the getting started area for Store I will document ng add @ngrx/store under the getting started area for Store DevTools I will document the ng add @ngrx/store-devtools and etc...

@brandonroberts
Copy link
Member

What do you think about having a dedicated "Installation" page for each library? It would have the normal npm/yarn instructions, and have the instructions on using ng-add and what it does. I want to keep the overview pages pretty light.

@timdeschryver
Copy link
Member

@wesleygrimes I was just typing the same thing but in another way.
What about adding a general Installation page with all of ng add commands.

@wesleygrimes
Copy link
Contributor Author

@brandonroberts @timdeschryver I'm good with either way... I personally like the idea of an Installation link under each main section like Store > Installation, Store Devtools > Installation. And then I will move what is in Getting started there for each and add the ng add commands there as well.

@wesleygrimes
Copy link
Contributor Author

@brandonroberts @timdeschryver ok, I almost have it, one question, do you want the getting started pages to still have a link to the installation pages or do you just want them to find it by clicking the navigation links?

@brandonroberts
Copy link
Member

I think a link to the page is good.

@wesleygrimes wesleygrimes changed the title docs(guide): add usage of ng add commands docs(guide): reorganize installation instructions into individual pages for each module Jan 23, 2019
@wesleygrimes
Copy link
Contributor Author

@brandonroberts @timdeschryver ok updates have been posted, also renamed the PR to reflect more of what is included.

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jan 23, 2019

Preview docs changes for 9b3d048 at https://previews.ngrx.io/pr1523-9b3d048/

Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

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

LGTM 👍 !
Would you also want to include the rest of the ng add commands?

… include documentation for optional ng add flags
@wesleygrimes
Copy link
Contributor Author

@timdeschryver @brandonroberts I have pushed a final commit that includes the ng add documentation for each module. It also now includes all the optional flags that you can pass for each module. Let me know if you need anything else. Thanks ya'll!

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jan 24, 2019

Preview docs changes for 67c1238 at https://previews.ngrx.io/pr1523-67c1238/

@timdeschryver timdeschryver mentioned this pull request Jan 24, 2019
3 tasks
Copy link
Member

@brandonroberts brandonroberts left a comment

Choose a reason for hiding this comment

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

Minor fixes with extra semicolons and typo

projects/ngrx.io/content/guide/effects/install.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/install.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/entity/install.md Outdated Show resolved Hide resolved
@brandonroberts
Copy link
Member

Prefix commits with docs: also.

Looks great!

@wesleygrimes
Copy link
Contributor Author

Thanks! I’ll get these resolved in the morning! Have a great evening.

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jan 25, 2019

Preview docs changes for 6bd14b8 at https://previews.ngrx.io/pr1523-6bd14b8/

@brandonroberts brandonroberts changed the title docs(guide): reorganize installation instructions into individual pages for each module docs: reorganize installation instructions into individual pages for each module Jan 25, 2019
@brandonroberts brandonroberts merged commit d6cc83c into ngrx:master Jan 25, 2019
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.

4 participants