5 Commits

Author	SHA1	Message	Date
Brandy Carney	aa48963212	docs(testing): update testing instructions for debugging tests (#29800) ... Adds more information to the testing documentation on how to execute individual tests or pause execution.	2024-08-26 16:17:36 +00:00	octicon-copy(16/) octicon-file-diff(16/) octicon-file-code(16/)
Maria Hutt	9cec8439f8	docs(screenshots): add step for specific component testing (#29594) ... Issue number: N/A --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> There is no documentation on how to use the input field in the screenshots GH actions. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - Added steps and examples on how to specify a component within screenshots GH actions. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change: 1. Describe the impact and migration path for existing applications below. 2. Update the BREAKING.md file with the breaking change. 3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md#footer for more information. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> N/A	2024-06-12 15:04:12 +00:00	octicon-copy(16/) octicon-file-diff(16/) octicon-file-code(16/)
Liam DeBeasi	ba5cebf254	docs(testing): add correct command (#29441) ... The original command does not exist.	2024-05-01 21:02:41 +00:00	octicon-copy(16/) octicon-file-diff(16/) octicon-file-code(16/)
Liam DeBeasi	bfaf528e61	docs(test): clarify docker usage for windows (#29274) ... Team members on Windows were having trouble running tests inside of Docker. Given that headed tests must use WSL, I think it makes sense to have Windows devs use WSL for any E2E tests run inside of Docker. That way they aren't switching back and forth between shells. This PR clarifies the Docker docs that instruct devs on how to use WSL.	2024-04-15 17:46:17 +00:00	octicon-copy(16/) octicon-file-diff(16/) octicon-file-code(16/)
Brandy Carney	b315b0cb29	chore(docs): consolidate the developer resource files into a docs/ directory (#29266) ... Start your review here 👉 [docs/README.md](https://github.com/ionic-team/ionic-framework/blob/FW-6107/docs/README.md) ## What is the current behavior? Documentation files with information on how to contribute, component implementations, testing, etc. are scattered throughout various folders in this repository. ## What is the new behavior? Consolidates the documentation files into a root `docs/` directory for easier discovery and organization. `/docs` tree: ``` ├── _config.yml ├── component-guide.md ├── CONTRIBUTING.md ├── README.md ├── sass-guidelines.md ├── angular │   ├── README.md │   └── testing.md ├── core │   ├── README.md │   └── testing │   ├── README.md │   ├── api.md │   ├── best-practices.md │   ├── preview-changes.md │   └── usage-instructions.md ├── react │   ├── README.md │   └── testing.md ├── react-router │   ├── README.md │   └── testing.md ├── vue │   ├── README.md │   └── testing.md └── vue-router ├── README.md └── testing.md ``` **Migrates the following:** | Previous Location | New Location | | ----------------------------------------------------------- | ----------------------------------------- | | `.github/COMPONENT-GUIDE.md` | `docs/component-guide.md` | | `.github/CONTRIBUTING.md` | `docs/CONTRIBUTING.md` | | `core/scripts/README.md` | `docs/core/testing/preview-changes.md` | | `core/src/utils/test/playwright/docs/api.md` | `docs/core/testing/api.md` | | `core/src/utils/test/playwright/docs/best-practices.md` | `docs/core/testing/best-practices.md` | | `core/src/utils/test/playwright/docs/README.md` | `docs/core/testing/README.md` | | `core/src/utils/test/playwright/docs/usage-instructions.md` | `docs/core/testing/usage-instructions.md` | | `packages/angular/test/README.md` | `docs/angular/testing.md` | | `packages/react-router/test/README.md` | `docs/react-router/testing.md` | | `packages/react/test/README.md` | `docs/react/testing.md` | | `packages/react/test/base/README.md` | `docs/react/testing.md` | | `packages/vue/test/README.md` | `docs/vue/testing.md` | **Adds the following:** | File | Description | | ----------------------------- | ----------------------------------------------------------------------- | | `docs/sass-guidelines.md` | Sass Variable guidelines taken from `ionic-framework-design-documents` | | `docs/README.md` | Entry file that should link to all other files | | `docs/_config.yml` | Config file for use with GitHub pages | | `docs/core/README.md` | Description of core, links to contributing and testing | | `docs/angular/README.md` | Description of angular, links to contributing and testing | | `docs/react/README.md` | Description of react, links to contributing and testing | | `docs/react-router/README.md` | Description of react-router, links to contributing and testing | | `docs/vue/README.md` | Description of vue, links to contributing and testing | | `docs/vue-router/README.md` | Description of vue-router, links to contributing and testing | | `docs/vue-router/testing.md` | Testing file for vue-router, populated from vue-router's main README | **Does not** add any files for `angular-server`. This is because the README is essentially empty and there is no testing in that directory. I can add blank files if we want to have something to add to later. **Does not** migrate the content of the packages' root `README.md` files. These files are used for their npm package descriptions so we should not edit them. ## Hosting Documentation We can (and should) host these files using GitHub Pages. I have duplicated them in a personal repository to see how this would look: [docs-consolidation](https://brandyscarney.github.io/docs-consolidation/). Doing so will require some formatting fixes (see [Sass Guidelines](https://brandyscarney.github.io/docs-consolidation/sass-guidelines.html#-reusable-values)) so I did not publish them now but we can easily enable GitHub pages by toggling a setting in this repository. ## Other information - Verify that no documentation files were missed in the migration - You can use these commands to search for `*.md` files in a directory: - `find core/src -type f -name "*.md" -print` - `find packages/angular -type f -name "*.md" -not -path "**/node_modules/*" -print` - I did add some redirect links in some of the existing markdown files so they might still exist for that reason - We should probably break up the contributing + component guide documentation into smaller files, such as including best practices, but I wanted to get everything in the same place first - The contributing has sections on each of the packages that we could move to that package's docs folder: https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#core --------- Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>	2024-04-08 19:06:26 +00:00	octicon-copy(16/) octicon-file-diff(16/) octicon-file-code(16/)