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: fix broken links #907

Merged
merged 6 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Cybozu, Inc.

<!-- credits-begin -->

[<img src="https://avatars.githubusercontent.com/u/33759872?v=4" alt="tasshi-me avatar" width="50" />](https://github.com/tasshi-me) [<img src="https://avatars.githubusercontent.com/u/59815499?v=4" alt="hung-cybo avatar" width="50" />](https://github.com/hung-cybo) [<img src="https://avatars.githubusercontent.com/u/41720778?v=4" alt="tuanphamcybozu avatar" width="50" />](https://github.com/tuanphamcybozu) [<img src="https://avatars.githubusercontent.com/u/14119304?v=4" alt="chick-p avatar" width="50" />](https://github.com/chick-p) [<img src="https://avatars.githubusercontent.com/u/9845816?v=4" alt="shisama avatar" width="50" />](https://github.com/shisama) [<img src="https://avatars.githubusercontent.com/u/1001444?v=4" alt="zaki-yama avatar" width="50" />](https://github.com/zaki-yama) [<img src="https://avatars.githubusercontent.com/u/250407?v=4" alt="koba04 avatar" width="50" />](https://github.com/koba04) [<img src="https://avatars.githubusercontent.com/u/22951237?v=4" alt="b4h0-c4t avatar" width="50" />](https://github.com/b4h0-c4t) [<img src="https://avatars.githubusercontent.com/u/1995370?v=4" alt="nakajmg avatar" width="50" />](https://github.com/nakajmg) [<img src="https://avatars.githubusercontent.com/u/48338353?v=4" alt="shintaroNagata avatar" width="50" />](https://github.com/shintaroNagata) [<img src="https://avatars.githubusercontent.com/u/46946976?v=4" alt="kjmnmt avatar" width="50" />](https://github.com/kjmnmt) [<img src="https://avatars.githubusercontent.com/u/534166?v=4" alt="ueokande avatar" width="50" />](https://github.com/ueokande) [<img src="https://avatars.githubusercontent.com/u/62086225?v=4" alt="ksm-cy avatar" width="50" />](https://github.com/ksm-cy) [<img src="https://avatars.githubusercontent.com/u/62008782?v=4" alt="ryounasso avatar" width="50" />](https://github.com/ryounasso) [<img src="https://avatars.githubusercontent.com/u/117426935?v=4" alt="jesslynvc avatar" width="50" />](https://github.com/jesslynvc) [<img src="https://avatars.githubusercontent.com/u/30670749?v=4" alt="ahandsel avatar" width="50" />](https://github.com/ahandsel)
[<img src="https://avatars.githubusercontent.com/u/33759872?v=4" alt="tasshi-me avatar" width="50" />](https://github.com/tasshi-me) [<img src="https://avatars.githubusercontent.com/u/59815499?v=4" alt="hung-cybo avatar" width="50" />](https://github.com/hung-cybo) [<img src="https://avatars.githubusercontent.com/u/41720778?v=4" alt="tuanphamcybozu avatar" width="50" />](https://github.com/tuanphamcybozu) [<img src="https://avatars.githubusercontent.com/u/14119304?v=4" alt="chick-p avatar" width="50" />](https://github.com/chick-p) [<img src="https://avatars.githubusercontent.com/u/9845816?v=4" alt="shisama avatar" width="50" />](https://github.com/shisama) [<img src="https://avatars.githubusercontent.com/u/1001444?v=4" alt="zaki-yama avatar" width="50" />](https://github.com/zaki-yama) [<img src="https://avatars.githubusercontent.com/u/250407?v=4" alt="koba04 avatar" width="50" />](https://github.com/koba04) [<img src="https://avatars.githubusercontent.com/u/22951237?v=4" alt="b4h0-c4t avatar" width="50" />](https://github.com/b4h0-c4t) [<img src="https://avatars.githubusercontent.com/u/1995370?v=4" alt="nakajmg avatar" width="50" />](https://github.com/nakajmg) [<img src="https://avatars.githubusercontent.com/u/48338353?v=4" alt="shintaroNagata avatar" width="50" />](https://github.com/shintaroNagata) [<img src="https://avatars.githubusercontent.com/u/46946976?v=4" alt="kjmnmt avatar" width="50" />](https://github.com/kjmnmt) [<img src="https://avatars.githubusercontent.com/u/534166?v=4" alt="ueokande avatar" width="50" />](https://github.com/ueokande) [<img src="https://avatars.githubusercontent.com/u/62086225?v=4" alt="ksm-cy avatar" width="50" />](https://github.com/ksm-cy) [<img src="https://avatars.githubusercontent.com/u/53943902?v=4" alt="shabaraba avatar" width="50" />](https://github.com/shabaraba) [<img src="https://avatars.githubusercontent.com/u/62008782?v=4" alt="ryounasso avatar" width="50" />](https://github.com/ryounasso) [<img src="https://avatars.githubusercontent.com/u/8196725?v=4" alt="chihiro-adachi avatar" width="50" />](https://github.com/chihiro-adachi) [<img src="https://avatars.githubusercontent.com/u/55537988?v=4" alt="nameless-mc avatar" width="50" />](https://github.com/nameless-mc) [<img src="https://avatars.githubusercontent.com/u/117426935?v=4" alt="jesslynvc avatar" width="50" />](https://github.com/jesslynvc) [<img src="https://avatars.githubusercontent.com/u/30670749?v=4" alt="ahandsel avatar" width="50" />](https://github.com/ahandsel)

<!-- credits-end -->
12 changes: 12 additions & 0 deletions website/contributors.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,22 @@
"login": "ksm-cy",
"avatar_url": "https://avatars.githubusercontent.com/u/62086225?v=4"
},
{
"login": "shabaraba",
"avatar_url": "https://avatars.githubusercontent.com/u/53943902?v=4"
},
{
"login": "ryounasso",
"avatar_url": "https://avatars.githubusercontent.com/u/62008782?v=4"
},
{
"login": "chihiro-adachi",
"avatar_url": "https://avatars.githubusercontent.com/u/8196725?v=4"
},
{
"login": "nameless-mc",
"avatar_url": "https://avatars.githubusercontent.com/u/55537988?v=4"
},
{
"login": "jesslynvc",
"avatar_url": "https://avatars.githubusercontent.com/u/117426935?v=4"
Expand Down
4 changes: 2 additions & 2 deletions website/docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ pnpm fix

### Stability

We define the [Stability Index](./stability-index) to indicate stability of features.
We define the [Stability Index](./stability-index.md) to indicate stability of features.

For experimental/deprecated features, please add [admonitions](https://docusaurus.io/docs/markdown-features/admonitions) on docs and show warnings on CLI.

Expand Down Expand Up @@ -276,4 +276,4 @@ Normally, maintainer will trigger a release weekly.

We follow the [Semantic Versioning](https://semver.org/).

For more details, see [Versioning Policy](./versioning) page.
For more details, see [Versioning Policy](./versioning.md) page.
2 changes: 1 addition & 1 deletion website/docs/community/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ We accept feature requests on [GitHub Issues](https://github.com/kintone/cli-kin
## Contributing

We always welcome contribution!
Please check [Contributing](./contributing) page.
Please check [Contributing](./contributing.md) page.

## News

Expand Down
6 changes: 3 additions & 3 deletions website/docs/community/stability-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page describes how we indicate the stability of cli-kintone features.

## Basics

Basically, cli-kintone maintains backward compatibility and follows the [Versioning Policy](./versioning) but also includes features that are under development or can be removed.
Basically, cli-kintone maintains backward compatibility and follows the [Versioning Policy](./versioning.md) but also includes features that are under development or can be removed.

We use the **Stability Index** to indicate the stability of cli-kintone features.
There are three indexes: stable, experimental, and deprecated.
Expand All @@ -17,13 +17,13 @@ There are three indexes: stable, experimental, and deprecated.

By default, features are categorized in this index.

Changes are reflected in the version according to the [Versioning Policy](./versioning).
Changes are reflected in the version according to the [Versioning Policy](./versioning.md).

## Experimental

This is an index for unstable features.

Changes are not subject to the [Versioning Policy](./versioning). Breaking changes or removal may occur.
Changes are not subject to the [Versioning Policy](./versioning.md). Breaking changes or removal may occur.
Production use is not recommended.

In the documentation, features are described with **Experimental** admonitions.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/community/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This page describes how we increment the cli-kintone version.

:::info

To learn how we manage the stability of cli-kintone, see the [Stability Index](./stability-index) first.
To learn how we manage the stability of cli-kintone, see the [Stability Index](./stability-index.md) first.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ To run cli-kintone, a Kintone subscription with API access is required.
</TabItem>
</Tabs>

For more details, see [Installation](./installation) page.
For more details, see [Installation](./installation.md) page.

### Operation check

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/record-delete/encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The default is `utf8`
## Errors

- Specified unsupported encoding
- [Mismatch encoding](../errors/mismatch-encoding)
- [Mismatch encoding](../errors/mismatch-encoding.md)
58 changes: 29 additions & 29 deletions website/docs/reference/record-export/fields/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@ Basically, the output is the same as the `value` property of the [API response](

## General fields

| Field type | Output |
| -------------------- | --------------------------------------------------------------------------------------- |
| Text | Same as API response |
| Text area | Same as API response |
| Rich text | Same as API response |
| Number | Same as API response |
| Calculated | Same as API response |
| Check box | Same as API response |
| Radio button | Same as API response |
| Multi-choice | Same as API response |
| Drop-down | Same as API response |
| User selection | [User selection, Department selection, and Group selection](./user-group-org-selection) |
| Department selection | [User selection, Department selection, and Group selection](./user-group-org-selection) |
| Group selection | [User selection, Department selection, and Group selection](./user-group-org-selection) |
| Date | YYYY-MM-DD<br/>e.g. 2022-04-01 |
| Time | HH:MM<br/>e.g. 09:30 |
| Date and time | YYYY-MM-DDTHH:MM:SSZ<br/>e.g. 2022-04-11T07:00Z |
| Link | Same as API response |
| Attachment | [Attachment](./attachment) |
| Lookup | Not supported |
| Table | [Table](./table) |
| Related records | Not supported |
| Category | Not supported |
| Status | Not supported |
| Assignee | Not supported |
| Label | Not supported |
| Blank space | Not supported |
| Border | Not supported |
| Group | Not supported |
| Field type | Output |
| -------------------- | ------------------------------------------------------------------------------------------ |
| Text | Same as API response |
| Text area | Same as API response |
| Rich text | Same as API response |
| Number | Same as API response |
| Calculated | Same as API response |
| Check box | Same as API response |
| Radio button | Same as API response |
| Multi-choice | Same as API response |
| Drop-down | Same as API response |
| User selection | [User selection, Department selection, and Group selection](./user-group-org-selection.md) |
| Department selection | [User selection, Department selection, and Group selection](./user-group-org-selection.md) |
| Group selection | [User selection, Department selection, and Group selection](./user-group-org-selection.md) |
| Date | YYYY-MM-DD<br/>e.g. 2022-04-01 |
| Time | HH:MM<br/>e.g. 09:30 |
| Date and time | YYYY-MM-DDTHH:MM:SSZ<br/>e.g. 2022-04-11T07:00Z |
| Link | Same as API response |
| Attachment | [Attachment](./attachment.md) |
| Lookup | Not supported |
| Table | [Table](./table.md) |
| Related records | Not supported |
| Category | Not supported |
| Status | Not supported |
| Assignee | Not supported |
| Label | Not supported |
| Blank space | Not supported |
| Border | Not supported |
| Group | Not supported |
2 changes: 1 addition & 1 deletion website/docs/reference/record-import/encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The default is `utf8`
## Errors

- Specified unsupported encoding
- [Mismatch encoding](../errors/mismatch-encoding)
- [Mismatch encoding](../errors/mismatch-encoding.md)
Loading
Loading