docs(getting-started): update readme.md and bootstrap.md files #3933

ghost · 2018-03-06T15:35:03Z

It was done in readme.md:

updated Installation instructions
(add info about adding packages and how to add component in html)
updated How to build lib for development
(add 'Keeping a fork up to date' section)
updated Headers style
(for semantics, first heading is h1, other - h2 and below )
deleted licence link from Table of contents list but add it to the end of the page
(agreed at the meeting - as usual licence is added at the end of the readme page)
join together angular-cli and Bootstrap 4 and angular-cli sections to Bootstrap 3 or 4 and angular-cli in the How to use it with section
(because they has similar structure and goals)

Also was decided ( at the meeting ) to update bootstrap.md files:

rename "testing" to "checkout"
(this name is more logic, because this section doesn't describe how to add tests)
add example with adding css style to index.html
(for better understanding how user can add css styles)
move bootstrap versions from main title to text + change file's name from bootstrap4 to bootstrap
(because this file not only for bootstrap 4, it's an instruction how to use bootstrap 3 and bootstrap 4 with angular-cli)

closes #3934

ghost · 2018-03-06T16:30:21Z

fix button_page_spec to run test

codecov · 2018-03-06T16:35:14Z

Codecov Report

Merging #3933 into development will decrease coverage by 0.06%.
The diff coverage is n/a.

@@               Coverage Diff               @@
##           development    #3933      +/-   ##
===============================================
- Coverage        72.23%   72.17%   -0.07%     
===============================================
  Files              253      253              
  Lines             8238     8238              
  Branches          1565     1565              
===============================================
- Hits              5951     5946       -5     
- Misses            1866     1868       +2     
- Partials           421      424       +3

Impacted Files	Coverage Δ
src/chronos/i18n/it.ts	`71.42% <0%> (-28.58%)`	⬇️
src/chronos/i18n/pl.ts	`72.22% <0%> (-5.56%)`	⬇️
src/chronos/i18n/uk.ts	`78.04% <0%> (-2.44%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d8ee1f8...d42161b. Read the comment docs.

README.md

 ```bash
 npm install ngx-bootstrap --save
 ```

-You will need bootstrap styles (Bootstrap 3)
+Add needed package to AppModule imports:


cypress/integration/buttons_page_spec.ts

@@ -66,67 +66,68 @@ describe('Buttons page test suite', () => {
    buttons.clickByText(buttonDemos[2], buttonNames[1]);


docs/getting-started/bootstrap.md

- - Open the file .angular-cli.json from the root of your project.
- - Under the property apps the first item in that array is the default application.
- - There is a property styles which allows external global styles to be applied to your application.
+Now that the project is set up it must be configured to include the Bootstrap CSS. You have two choices:


docs/getting-started/bootstrap.md

-    "component": {}  
-  }  
+"styles": [
+  "styles.scss" <-- rename this from .css to .scss


docs/getting-started/bootstrap.md

+.
+.
+"defaults": {
+  "styleExt": "scss", <-- set this to default to .scss


docs/getting-started/bootstrap.md

+.
+"defaults": {
+  "styleExt": "scss", <-- set this to default to .scss
+  "component": {}


YevheniiaMazur · 2018-03-15T16:32:44Z

Please, update PR and task names, cause now it looks like two features in one PR.
And also please, add descriptions to checklist what was done (in issue or in PR), not clear why we need several of them

ghost · 2018-03-19T13:08:01Z

@YevheniiaMazur fixed

YevheniiaMazur · 2018-03-20T11:23:23Z

@svetoldo4444ka , should I directly read these files, or they affected demo or other structure objects? Is these files are content of Getting started page?

YevheniiaMazur · 2018-03-21T14:12:57Z

Several fixes/clarifyings needed:

Link to bootstrap.md file at README file throws 404 error:
Why we need command npm run test for updating fork?
Why we need latest stable version of angular for using angular-cli with bootstrap? If I'm not wrong, it'll work with previous versions too
Maybe will be better use flag --save-dev (to add bootstrap directly to project's devDependencies) or any flag, written at npm documentation instead of --save? cause in npm documentation there are no examples of using flag --save without suffix

link to documentation: https://docs.npmjs.com/cli/install
Why we need duplicating info in README file

And in bootstrap.md file

… into docs-change-documentation

ghost · 2018-03-22T13:33:17Z

@YevheniiaMazur @EvilAlexei @v1ktoryy
According to meeting:

3 and 5 list items was decided to retain
4 list items will be fixed
2 item:

was decided to change title
add stepd to
http://joxi.ru/L216zjet6d1dbA
add comment for

according to 1 comment:
Link to bootstrap.md file at README file throws 404 error because this file isn't exist in this branch while it isn't pushed in development branch. And now I can't check it

…/ngx-bootstrap into docs-change-documentation

README.md

 ```bash
-npm install ngx-bootstrap --save
+npm install ngx-bootstrap --save-dev


README.md

-## How to use it with:
- - `angular-cli` please refer to [getting-started-with-ng-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/ng-cli.md)
+### How to use it with:
+ - `Bootstrap 3 or 4 and angular-cli` please refer to [using-with-bootstrap-and-angular-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/bootstrap.md)


docs/getting-started/bootstrap.md

+ - install `ngx-bootstrap` and `Bootstrap`
+
+ ```bash
+ npm install ngx-bootstrap bootstrap --save-dev


valorkin · 2018-03-29T09:49:21Z

@svetoldo4444ka apply code review comments

ghost · 2018-03-29T11:19:33Z

@valorkin @EvilAlexei fixed according to the comments( commit - docs(getting-started): update readme.md and bootstrap.md files according to the comments)

ghost · 2018-03-29T13:52:52Z

@YevheniiaMazur @EvilAlexei
according to @valorkin comments:

returned command npm install ngx-bootstrap --save
changed

To

README.md

+ - `git pull upstream development`
+ - `rm -rf node_modules`
+ - `npm install`
+ - `npm run test` _*// it will build the lib, create a link in node_modules and run package's "test" script*_

 To run bootstrap 3 and 4 demo:


…ing to the comments

YevheniiaMazur · 2018-04-03T11:31:28Z

Tested, looks good.
Link to bootstrap.md file at README file should be retested after merging PR, due to reason answered before:

ghost changed the title ~~docs(documentation): update readme and bootstrap.md files~~ docs(readme): update readme.md and bootstrap.md files Mar 6, 2018

IlyaSurmay suggested changes Mar 7, 2018

View reviewed changes

IlyaSurmay added comp(docs) needs fix labels Mar 7, 2018

IlyaSurmay suggested changes Mar 12, 2018

View reviewed changes

valorkin previously approved these changes Mar 13, 2018

View reviewed changes

ghost dismissed valorkin’s stale review via ab44cde March 13, 2018 12:43

IlyaSurmay previously approved these changes Mar 14, 2018

View reviewed changes

ghost dismissed IlyaSurmay’s stale review via 40ef14c March 14, 2018 16:45

svetoldo4444ka added 4 commits March 14, 2018 18:46

docs(documentation): update readme and bootstrap.md files

bd93f1d

docs(readme): fix conflicts

131aa1d

docs(readme): fix conflicts

c2e186d

Merge branch 'development' into docs-change-documentation

16915ff

IlyaSurmay previously approved these changes Mar 15, 2018

View reviewed changes

Merge branch 'development' into docs-change-documentation

b5b5aff

ghost assigned IlyaSurmay Mar 15, 2018

ghost added the in progress label Mar 15, 2018

IlyaSurmay added ready for tests and removed in progress needs fix labels Mar 15, 2018

YevheniiaMazur added in test and removed ready for tests labels Mar 15, 2018

YevheniiaMazur added needs fix and removed in test labels Mar 15, 2018

ghost changed the title ~~docs(readme): update readme.md and bootstrap.md files~~ docs(getting-started): update readme.md and bootstrap.md files Mar 16, 2018

YevheniiaMazur added needs fix and removed in test labels Mar 21, 2018

Merge branch 'development' of github.com:svetoldo4444ka/ngx-bootstrap…

bdf8d76

… into docs-change-documentation

docs(getting-started): update readme.md and bootstrap.md files

3d254e3

ghost dismissed IlyaSurmay’s stale review via bcd0feb March 22, 2018 14:15

Merge branch 'docs-change-documentation' of github.com:svetoldo4444ka…

03bc5d6

…/ngx-bootstrap into docs-change-documentation

valorkin requested changes Mar 29, 2018

View reviewed changes

ghost added the in progress label Mar 30, 2018

IlyaSurmay suggested changes Mar 30, 2018

View reviewed changes

README.md Outdated

- `git pull upstream development`

- `rm -rf node_modules`

- `npm install`

- `npm run test` _*// it will build the lib, create a link in node_modules and run package's "test" script*_

To run bootstrap 3 and 4 demo:

This comment was marked as off-topic.

Sign in to view

IlyaSurmay removed the in progress label Mar 30, 2018

svetoldo4444ka and others added 2 commits April 2, 2018 11:30

docs(getting-started): update readme.md and bootstrap.md files accord…

09f8584

…ing to the comments

Merge branch 'development' into docs-change-documentation

d42161b

ghost added the in progress label Apr 2, 2018

IlyaSurmay approved these changes Apr 2, 2018

View reviewed changes

IlyaSurmay added ready for tests and removed in progress needs fix labels Apr 2, 2018

YevheniiaMazur added in test and removed ready for tests labels Apr 3, 2018

YevheniiaMazur added ready for merge and removed in test labels Apr 3, 2018

valorkin approved these changes Apr 5, 2018

View reviewed changes

valorkin merged commit 621e8dd into valor-software:development Apr 5, 2018

ghost removed the ready for merge label Apr 5, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(getting-started): update readme.md and bootstrap.md files #3933

docs(getting-started): update readme.md and bootstrap.md files #3933

ghost commented Mar 6, 2018 •

edited by ghost

Loading

ghost commented Mar 6, 2018

codecov bot commented Mar 6, 2018 •

edited

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

YevheniiaMazur commented Mar 15, 2018

ghost commented Mar 19, 2018

YevheniiaMazur commented Mar 20, 2018 •

edited

Loading

YevheniiaMazur commented Mar 21, 2018

ghost commented Mar 22, 2018 •

edited by ghost

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

valorkin commented Mar 29, 2018

ghost commented Mar 29, 2018

ghost commented Mar 29, 2018

This comment was marked as off-topic.

YevheniiaMazur commented Apr 3, 2018

		@@ -66,67 +66,68 @@ describe('Buttons page test suite', () => {
		buttons.clickByText(buttonDemos[2], buttonNames[1]);

docs(getting-started): update readme.md and bootstrap.md files #3933

docs(getting-started): update readme.md and bootstrap.md files #3933

Conversation

ghost commented Mar 6, 2018 • edited by ghost Loading

ghost commented Mar 6, 2018

codecov bot commented Mar 6, 2018 • edited Loading

Codecov Report

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

YevheniiaMazur commented Mar 15, 2018

ghost commented Mar 19, 2018

YevheniiaMazur commented Mar 20, 2018 • edited Loading

YevheniiaMazur commented Mar 21, 2018

ghost commented Mar 22, 2018 • edited by ghost Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

valorkin commented Mar 29, 2018

ghost commented Mar 29, 2018

ghost commented Mar 29, 2018

This comment was marked as off-topic.

YevheniiaMazur commented Apr 3, 2018

ghost commented Mar 6, 2018 •

edited by ghost

Loading

codecov bot commented Mar 6, 2018 •

edited

Loading

YevheniiaMazur commented Mar 20, 2018 •

edited

Loading

ghost commented Mar 22, 2018 •

edited by ghost

Loading