Skip to content

Commit

Permalink
docs: fix typo (#1919)
Browse files Browse the repository at this point in the history
Co-authored-by: Mateusz Daniluk <[email protected]>
  • Loading branch information
ptu14 and Mateusz Daniluk authored Oct 30, 2022
1 parent 8ff037b commit b7f6498
Show file tree
Hide file tree
Showing 14 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
workflow_dispatch:
inputs:
disttag:
description: 'Publish "@builder.io/qwik" to NPM using this dist-tag, push the git-tag to the repo and create a Github release. The "latest" and "next" dist-tags will use the version number already committed in package.json.'
description: 'Publish "@builder.io/qwik" to NPM using this dist-tag, push the git-tag to the repo and create a GitHub release. The "latest" and "next" dist-tags will use the version number already committed in package.json.'
required: true
type: choice
default: 'dev'
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Next the `start` command will:
yarn start
```

Finally you can use yarn workspace command to run packages' commands, for example:
Finally, you can use yarn workspace command to run packages' commands, for example:

```
yarn workspace qwik-docs dev.ssr
Expand Down Expand Up @@ -121,10 +121,10 @@ You'll be asked guiding questions which will eventually create a descriptive com
1. Run `yarn release.prepare`, which will test, lint and build.
2. Use the interactive UI to select the next version, which will update the `package.json` `version` property, add the git change, and start a commit message.
3. Create a PR with the `package.json` change to merge to `main`.
4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/BuilderIO/qwik/actions/workflows/ci.yml) button from the "Qwik CI" Github Action workflow.
4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/BuilderIO/qwik/actions/workflows/ci.yml) button from the "Qwik CI" GitHub Action workflow.
5. Select the NPM dist-tag that should be used for this version, then click "Run Workflow".
6. The Github Action will dispatch the workflow to build `@builder.io/qwik` and each of the submodules, build WASM and native bindings, combine them into one package, and validate the package before publishing to NPM.
7. If the build is successful and all tests and validation passes, the workflow will automatically publish to NPM, commit a git tag to the repo, and create a Github release.
6. The GitHub Action will dispatch the workflow to build `@builder.io/qwik` and each of the submodules, build WASM and native bindings, combine them into one package, and validate the package before publishing to NPM.
7. If the build is successful and all tests and validation passes, the workflow will automatically publish to NPM, commit a git tag to the repo, and create a GitHub release.
8. 🚀

## Pre-submit hooks
Expand All @@ -135,7 +135,7 @@ The project has pre-submit hooks, which ensure that your code is correctly forma
yarn lint
```

Some of the issues can be fixed automatically by using:
Some issues can be fixed automatically by using:

```
yarn fmt
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/components/footer/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export const Footer = component$(() => {
</a>
</li>
<li>
<a href="https://github.com/BuilderIO/qwik" target="_blank" title="Github">
<a href="https://github.com/BuilderIO/qwik" target="_blank" title="GitHub">
<GithubLogo width={22} height={22} />
</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/components/header/header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ export const Header = component$(() => {
/>
</li>
<li>
<a href="https://github.com/BuilderIO/qwik" target="_blank" title="Github">
<span class="md:hidden">Github</span>
<a href="https://github.com/BuilderIO/qwik" target="_blank" title="GitHub">
<span class="md:hidden">GitHub</span>
<span class="hidden md:block">
<GithubLogo width={22} height={22} />
</span>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/components/on-this-page/on-this-page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export const OnThisPage = component$(() => {
<li>
<a href="https://github.com/BuilderIO/qwik" target="_blank" rel="nofollow noopener">
<GithubLogo width={20} height={20} />
<span>Github</span>
<span>GitHub</span>
</a>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/components/svgs/github-logo.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const GithubLogo = ({ width, height }: GithubLogoProps) => (
height={height}
fill="currentColor"
role="img"
aria-label="Github Logo"
aria-label="GitHub Logo"
>
<path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z" />
</svg>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/docs/faq/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ We think resumability scales without the negative trade-offs of partial hydratio

## Does Qwik have community?

YES, there is a growing community of Qwik developers at [Discord](https://qwik.builder.io/chat) and [Github](https://github.com/BuilderIO/qwik), they are making amazing contributions to the framework, building sites at scale and helping each other. [Join us](https://qwik.builder.io/chat).
YES, there is a growing community of Qwik developers at [Discord](https://qwik.builder.io/chat) and [GitHub](https://github.com/BuilderIO/qwik), they are making amazing contributions to the framework, building sites at scale and helping each other. [Join us](https://qwik.builder.io/chat).


## Is Qwik production ready?
Expand Down
2 changes: 1 addition & 1 deletion packages/qwik-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ npm run build.server
## Related

- [Qwik Docs](https://qwik.builder.io/docs/overview/)
- [Qwik Github](https://github.com/BuilderIO/qwik)
- [Qwik on GitHub](https://github.com/BuilderIO/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Discord](https://qwik.builder.io/chat)
- [Vite](https://vitejs.dev/)
Expand Down
2 changes: 1 addition & 1 deletion starters/apps/basic/src/routes/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export default component$(() => {
<li>
<span>Open issues and contribute on </span>
<a href="https://github.com/BuilderIO/qwik" target="_blank">
Github
GitHub
</a>
</li>
<li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default component$(() => {
<a href="https://twitter.com/QwikDev">Twitter</a>
</li>
<li>
<a href="https://github.com/BuilderIO/qwik">Github</a>
<a href="https://github.com/BuilderIO/qwik">GitHub</a>
</li>
<li>
<a href="https://qwik.builder.io/chat">Chat</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export default component$(() => {
</li>
<li>
<a href="https://github.com/BuilderIO/qwik" target="_blank">
Github
GitHub
</a>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion starters/apps/documentation-site/src/routes/docs/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

- [@QwikDev](https://twitter.com/QwikDev)
- [Discord](https://qwik.builder.io/chat)
- [Github](https://github.com/BuilderIO/qwik)
- [GitHub](https://github.com/BuilderIO/qwik)
2 changes: 1 addition & 1 deletion starters/apps/documentation-site/src/routes/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export default component$(() => {
<li>
<span>Open issues and contribute on </span>
<a href="https://github.com/BuilderIO/qwik" target="_blank">
Github
GitHub
</a>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion starters/apps/library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- [Qwik Docs](https://qwik.builder.io/)
- [Discord](https://qwik.builder.io/chat)
- [Qwik Github](https://github.com/BuilderIO/qwik)
- [Qwik on GitHub](https://github.com/BuilderIO/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Vite](https://vitejs.dev/)
- [Partytown](https://partytown.builder.io/)
Expand Down

0 comments on commit b7f6498

Please sign in to comment.