Skip to content

Commit

Permalink
docs: update docs with new paths
Browse files Browse the repository at this point in the history
  • Loading branch information
tkajtoch committed May 6, 2024
1 parent 65411da commit b90ae15
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Create the component directory

1. Create a directory for your component in `src/components/`. All folder and file names should be `snake_cased`.
1. Create a directory for your component in `packages/eui/src/components/`. All folder and file names should be `snake_cased`.

#### Logical groupings of directories

Expand All @@ -20,7 +20,7 @@ then they belong in the same logical grouping (i.e., directory). A component dir

1. Create the React component(s) as TypeScript `.tsx` file(s) in your new component directory.
2. Export these components from an `index.ts` file.
3. Re-export these components from `src/components/index.ts`.
3. Re-export these components from `packages/eui/src/components/index.ts`.

This makes your React component available for import into your project.

Expand Down
9 changes: 5 additions & 4 deletions wiki/contributing-to-eui/developing/creating-icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,14 @@ _**Note**: Figma users can use the [SVG Export plugin][svg-plugin] to optimize S
Create a new feature branch against this repo and make the following changes:

_1. Add your glyph to the `EuiIcon` component_
- Add your SVG file to the `/src/components/icon/svgs` folder
- Add a reference in the `/src/components/icon/icon_map.ts` file (in alphabetical order)
- Add your SVG file to the `/packages/eui/src/components/icon/svgs` folder
- Add a reference in the `/packages/eui/src/components/icon/icon_map.ts` file (in alphabetical order)

_2. Display the icon in the docs_
- Add the icon name to `/src-docs/src/views/icon/icons.js` *
- Add the icon name to `/packages/eui/src-docs/src/views/icon/icons.js` *

_3. Compile and test_
- Go to the `packages/eui` directory
- Run `yarn compile-icons`
- Preview your icon locally at `http://localhost:8030/#/display/icons` **
- Switch the docs to dark mode and verify that the icon is visible (all paths should be filled with the reverse color)
Expand All @@ -84,7 +85,7 @@ Once your PR is approved, you will be able to merge it and give yourself a well-

---

_\* The Icons page actually contains several sections. In most cases, you will be adding your icon to the base set. However, if your icon should appear in a different set, then add it to the appropriate section file in `/src-docs/src/views/icon`._
_\* The Icons page actually contains several sections. In most cases, you will be adding your icon to the base set. However, if your icon should appear in a different set, then add it to the appropriate section file in `/packages/eui/src-docs/src/views/icon`._

_\** Run `yarn && yarn start` to view the EUI docs site locally._

Expand Down
9 changes: 7 additions & 2 deletions wiki/eui-team-processes/releasing-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ npm login # Will prompt for credentials and 2FA token
npm whoami # Should return your NPM username
```

Ensure you are on the `main` branch, and then start the release process by running the following command:
Ensure you are on the `main` branch and in the `packages/eui` directory:
```sh
git checkout main && npm run release
git checkout main && cd packages/eui
```

You can now start the release script by running the following command:
```sh
npm run release
```

This command ensures that you have the latest `upstream/main` and dependencies, as well as running all tests and then building the `lib` and `dist` distributions formats. Next the recent changes are read from `changelogs/upcoming/` and you will be asked to choose what part of the version to bump.
Expand Down

0 comments on commit b90ae15

Please sign in to comment.