From 4599d962d3d01c60bbabfbe3ea3ed59aee5df732 Mon Sep 17 00:00:00 2001 From: Vedant Singhania Date: Sat, 29 Jun 2024 17:42:49 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a1949629..e1953332 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,73 @@ -# guidemaker-ember-template +[![This project uses GitHub Actions for continuous integration.](https://github.com/ember-learn/guidemaker-ember-template/workflows/CI/badge.svg)](https://github.com/ember-learn/guidemaker-ember-template/actions?query=workflow%3ACI) +[![This project uses Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ember/guidemaker-ember-template) -[Short description of the addon.] +guidemaker-ember-template +============================================================================== -## Compatibility +This addon provides the general layout and some styles that are used for +[guides.emberjs.com](https://guides.emberjs.com/release). -- Ember.js v4.12 or above -- Embroider or ember-auto-import v2 +Its responsibilities include: +- CSS for the sidebar +- HTML markup specifics (i.e. the classes that go on various divs in the text of the +guide itself) -## Installation +## Related apps + +Most aspects of the Guides are styled via +[ember-styleguide](https://github.com/ember-learn/ember-styleguide), +not this repository. + +[guidemaker](https://github.com/empress/guidemaker) is what +assembles guides content into queryable records. + +[guides-source](https://github.com/ember-learn/guides-source) +has the learning content itself. + +Compatibility +------------------------------------------------------------------------------ + +* Ember.js v3.16 or above +* Ember CLI v3.16 or above +* Node.js v14 or above + + +Installation +------------------------------------------------------------------------------ ``` ember install guidemaker-ember-template ``` -## Usage -[Longer description of how to use the addon in apps.] +Usage +------------------------------------------------------------------------------ + +See [guides-source](https://github.com/ember-learn/guides-source) +for an example of how to use this addon. -## Contributing + +Contributing +------------------------------------------------------------------------------ See the [Contributing](CONTRIBUTING.md) guide for details. -## License +Releases +------------------------------------------------------------------------------ + +To release a new version of this addon: + +``` +git checkout master +git pull origin master +npm install -g np +np +``` + +This command will run checks and tests, and ask you what version you want +to do the release as (major, minor, patch). + +License +------------------------------------------------------------------------------ This project is licensed under the [MIT License](LICENSE.md). From 69f1b7823ed0a6a1bc8c253fd003a1b9a3d33f40 Mon Sep 17 00:00:00 2001 From: Vedant Singhania Date: Mon, 1 Jul 2024 13:15:54 -0700 Subject: [PATCH 2/5] Update README.md --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index e1953332..3457f178 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,56 @@ [![This project uses GitHub Actions for continuous integration.](https://github.com/ember-learn/guidemaker-ember-template/workflows/CI/badge.svg)](https://github.com/ember-learn/guidemaker-ember-template/actions?query=workflow%3ACI) [![This project uses Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ember/guidemaker-ember-template) -guidemaker-ember-template -============================================================================== +# guidemaker-ember-template This addon provides the general layout and some styles that are used for [guides.emberjs.com](https://guides.emberjs.com/release). -Its responsibilities include: +Its responsibilities include - CSS for the sidebar -- HTML markup specifics (i.e. the classes that go on various divs in the text of the -guide itself) +- HTML markup specifics (i.e. the classes that go on various divs in the text of the guide itself) ## Related apps -Most aspects of the Guides are styled via -[ember-styleguide](https://github.com/ember-learn/ember-styleguide), -not this repository. +Most aspects of the Guides are styled via [ember-styleguide](https://github.com/ember-learn/ember-styleguide),not this repository. -[guidemaker](https://github.com/empress/guidemaker) is what -assembles guides content into queryable records. +[guidemaker](https://github.com/empress/guidemaker) is what assembles guides content into queryable records. -[guides-source](https://github.com/ember-learn/guides-source) -has the learning content itself. +[guides-source](https://github.com/ember-learn/guides-source) has the learning content itself. -Compatibility ------------------------------------------------------------------------------- +## Compatibility +- Ember.js v4.12 or above +- Embroider or ember-auto-import v2 -* Ember.js v3.16 or above -* Ember CLI v3.16 or above -* Node.js v14 or above +## Installation +- `git clone ` +- `cd guidemaker-ember-template` +- `pnpm install` +## Linting +- `pnpm lint` +- `pnpm lint:fix` -Installation ------------------------------------------------------------------------------- +## Building the addon +- `cd guidemaker-ember-template` +- `pnpm build` -``` -ember install guidemaker-ember-template -``` +## Running tests +- `cd test-app` +- `pnpm test` – Runs the test suite on the current Ember version +- `pnpm test:watch` – Runs the test suite in "watch mode" +## Running the test application +- `cd test-app` +- `pnpm start` +- Visit the test application at [http://localhost:4200](http://localhost:4200). -Usage ------------------------------------------------------------------------------- +## Usage +See [guides-source](https://github.com/ember-learn/guides-source) for an example of how to use this addon. -See [guides-source](https://github.com/ember-learn/guides-source) -for an example of how to use this addon. - - -Contributing ------------------------------------------------------------------------------- +[Longer description of how to use the addon in apps.] +## Contributing See the [Contributing](CONTRIBUTING.md) guide for details. Releases @@ -67,7 +68,6 @@ np This command will run checks and tests, and ask you what version you want to do the release as (major, minor, patch). -License ------------------------------------------------------------------------------- +## License This project is licensed under the [MIT License](LICENSE.md). From 368608b8c063fd1bd48d4d4626bb0ef1118a7921 Mon Sep 17 00:00:00 2001 From: Vedant Singhania Date: Tue, 2 Jul 2024 10:24:14 -0700 Subject: [PATCH 3/5] Update README.md Co-authored-by: Ignace Maes --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 3457f178..cc64946b 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ # guidemaker-ember-template -This addon provides the general layout and some styles that are used for -[guides.emberjs.com](https://guides.emberjs.com/release). +This addon provides the general layout and some styles that are used for documentation websites such as [guides.emberjs.com](https://guides.emberjs.com/release/), and [cli.emberjs.com](https://cli.emberjs.com/release/). Its responsibilities include - CSS for the sidebar From 983935b236bbf5994ca407a7254cb3ae1e5328e9 Mon Sep 17 00:00:00 2001 From: Vedant Singhania Date: Tue, 2 Jul 2024 10:24:25 -0700 Subject: [PATCH 4/5] Update README.md Co-authored-by: Ignace Maes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc64946b..6057e2da 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Its responsibilities include ## Related apps -Most aspects of the Guides are styled via [ember-styleguide](https://github.com/ember-learn/ember-styleguide),not this repository. +Most aspects of the Guides are styled via [ember-styleguide](https://github.com/ember-learn/ember-styleguide), not this repository. [guidemaker](https://github.com/empress/guidemaker) is what assembles guides content into queryable records. From 82f76efde26984026a14926b567b03ebaa817b14 Mon Sep 17 00:00:00 2001 From: Vedant Singhania Date: Tue, 2 Jul 2024 10:24:39 -0700 Subject: [PATCH 5/5] Update README.md Co-authored-by: Ignace Maes --- README.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.md b/README.md index 6057e2da..47d0af9b 100644 --- a/README.md +++ b/README.md @@ -52,21 +52,6 @@ See [guides-source](https://github.com/ember-learn/guides-source) for an example ## Contributing See the [Contributing](CONTRIBUTING.md) guide for details. -Releases ------------------------------------------------------------------------------- - -To release a new version of this addon: - -``` -git checkout master -git pull origin master -npm install -g np -np -``` - -This command will run checks and tests, and ask you what version you want -to do the release as (major, minor, patch). - ## License This project is licensed under the [MIT License](LICENSE.md).