Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: launch doc website #788

Merged
merged 67 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
f0d45b1
docs: add installation page
tasshi-me Jun 13, 2024
86114aa
docs: update docs
tasshi-me Jun 13, 2024
529a8c6
docs: add reference of record export
tasshi-me Jun 13, 2024
667f613
docs: update footer copyright
tasshi-me Jun 13, 2024
f03dba7
docs: add reference of record import
tasshi-me Jun 13, 2024
d57c130
docs: add reference of record delete
tasshi-me Jun 13, 2024
c245533
docs: add misc references
tasshi-me Jun 13, 2024
ea813c3
docs: reorder references
tasshi-me Jun 13, 2024
06092ba
docs: add contributors credits
tasshi-me Jun 13, 2024
ebc2729
docs: fix credits generation
tasshi-me Jun 13, 2024
e132600
docs: add community section
tasshi-me Jun 14, 2024
3df38ef
docs: add contributing page
tasshi-me Jun 14, 2024
7271761
docs: add trace log level
tasshi-me Jun 14, 2024
8519484
docs: update getting started
tasshi-me Jun 14, 2024
23f48ce
docs: add options page
tasshi-me Jun 15, 2024
20855e2
docs: move some command options to options page
tasshi-me Jun 15, 2024
e249bfd
docs: kintone -> Kintone
tasshi-me Jun 15, 2024
c23b67d
docs: remove Docuraurus tutorials
tasshi-me Jun 15, 2024
ee53269
docs: small fixes
tasshi-me Jun 15, 2024
1b3091f
docs: remove `$` prefix from shell code block
tasshi-me Jun 15, 2024
13914f1
docs: add troubleshooting page
tasshi-me Jun 15, 2024
67ca285
docs: add diagram of proxy connection
tasshi-me Jun 15, 2024
e2dcd8e
docs: fix `edit this page` branch
tasshi-me Jun 15, 2024
8497151
docs: update README.md
tasshi-me Jun 15, 2024
7d4ac45
docs: update annoucement post
tasshi-me Jun 15, 2024
e7d8687
docs: fix broken links
tasshi-me Jun 15, 2024
57176a1
docs: note why we don't support password authn on deletion
tasshi-me Jun 15, 2024
5687efc
docs: add newline to contributers.json
tasshi-me Jun 15, 2024
1902007
Merge remote-tracking branch 'origin/main' into docs/migrate-readme-t…
tasshi-me Jun 15, 2024
07cc49c
docs: update README.md
tasshi-me Jun 15, 2024
5f1cd27
docs: add social card
tasshi-me Jun 16, 2024
ef9c72b
docs: update annoucement post
tasshi-me Jun 16, 2024
baf3cd9
docs: update tagline
tasshi-me Jun 16, 2024
7159878
docs: update CONTRIBUTING.md
tasshi-me Jun 16, 2024
c40a105
docs: add link to devnet cli-kintone tutorials
tasshi-me Jun 16, 2024
df67f8e
docs: update Docusaurus 3.3.2 -> 3.4.0
tasshi-me Jun 16, 2024
5b88159
docs: update features on top page
tasshi-me Jun 16, 2024
2da430c
docs: use Scss instead of vanilla CSS
tasshi-me Jun 16, 2024
a190687
docs: fix React errors
tasshi-me Jun 16, 2024
0c20c08
docs: remove TODO comment
tasshi-me Jun 16, 2024
2d99829
docs: use `ThemedImage` instead of `useColorMode`
tasshi-me Jun 16, 2024
07815ef
docs: use kintone color in light mode
tasshi-me Jun 16, 2024
172a5cd
docs: update color palette for light mode
tasshi-me Jun 16, 2024
fc0e3fa
docs: update notation of reference section
tasshi-me Jun 17, 2024
b899f30
chore: update npm scripts for website
tasshi-me Jun 17, 2024
8711d7b
docs: add author to credits
tasshi-me Jun 17, 2024
5780a81
docs: write Kurikinton in Japanese
tasshi-me Jun 17, 2024
dc54194
docs: fix CSS issues
tasshi-me Jun 17, 2024
a752c30
docs: add pronunciation tip
tasshi-me Jun 18, 2024
2ab8675
docs: removeing trailing slashes
tasshi-me Jun 19, 2024
da39c8a
docs: remove `--yes` option of record exporting
tasshi-me Jun 19, 2024
0582802
docs: add Guest space section to Options page
tasshi-me Jun 19, 2024
6081229
docs: add additional note about upsert
tasshi-me Jun 19, 2024
7acd66d
docs: replace `node cli.js` with `cli-kintone`
tasshi-me Jun 19, 2024
496b236
docs: remove xsv occurrences
tasshi-me Jun 19, 2024
5c00e66
docs: fix command examples
tasshi-me Jun 19, 2024
d5a19a7
docs: rewrite description of header row
tasshi-me Jun 19, 2024
10115db
docs: fix broken link
tasshi-me Jun 19, 2024
716b6e2
docs: fix file limitation descripition
tasshi-me Jun 19, 2024
7a6c8b2
docs: remove fields-order page for record import
tasshi-me Jun 19, 2024
cb3e74c
docs: remove TODO comment
tasshi-me Jun 19, 2024
1616fd6
docs: fix encoding description of record delete
tasshi-me Jun 19, 2024
c6da3c8
docs: fix the socket timeout duration
tasshi-me Jun 19, 2024
1662303
docs: fix typo
tasshi-me Jun 19, 2024
24932f3
docs: fix wrong example URL
tasshi-me Jun 19, 2024
8a9553c
docs: update post author
tasshi-me Jun 20, 2024
d1c1c76
Merge remote-tracking branch 'origin/main' into docs/website
tasshi-me Jun 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ allure-results
# website package
website/.docusaurus
website/build
## Auto generated file
website/contributors.json
5 changes: 2 additions & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ allure-results
*.html

# Ignore tsconfig file
tsconfig.json
/tsconfig.json

# Ignore auto generated files
pnpm-lock.yaml
Expand All @@ -19,8 +19,7 @@ CHANGELOG.md
## Ignore artifacts:
website/.docusaurus
website/build
## Ignore tsconfig file
website/tsconfig.json
## Ignore auto generated files
website/pnpm-lock.yaml
website/CHANGELOG.md
website/contributors.json
54 changes: 1 addition & 53 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,3 @@
# Contributing Guide

## For Contributors

Contributions are always welcome!
If you have discovered a bug or have a feature request, [please create an issue on GitHub](https://github.com/kintone/cli-kintone/issues/new/choose).
Pull requests are also welcome when you find trivial bugs or typos.

We use English for all commit messages, code comments, issues, pull requests.
For Japanese speakers, we have another repository: https://github.com/kintone/js-sdk-ja.
Please file an issue there.

(Translated in Japanese)
本リポジトリではコミットメッセージやコードコメント、issues、pull requests において英語を使用しています。
日本語話者向けに専用のリポジトリも用意しています: https://github.com/kintone/js-sdk-ja
こちらに issue をご登録ください。

### Setup

```sh
% cd cli-kintone
% yarn install
```

### Develop

```sh
% cd cli-kintone
% yarn start
```

### Test

Before run `lint` and `test` scripts, you have to run `build`.

```sh
% cd cli-kintone
% yarn build
% yarn test
% yarn lint
```

## For Maintainers

### Merge

After you have approved a PR, please merge the PR using **Squash and merge** with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.

```sh
feat: support importing CSV
```

### Release

TODO: Create release pipeline and write document
See [Contributing](https://cli.kintone.dev/community/contributing) page.
Loading
Loading