Skip to content

Commit 56f08e1

Browse files
authored
docs: Move verify to upper folder (#2546)
Signed-off-by: Xuanwo <[email protected]>
1 parent 58a68fa commit 56f08e1

File tree

5 files changed

+11
-18
lines changed

5 files changed

+11
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ Major components of the project include:
3535
**Services**
3636

3737
<details>
38-
<summary>Standard Storage Protocols (like fs, ftp)</summary>
38+
<summary>Standard Storage Protocols (like ftp, webdav)</summary>
3939

40-
- fs: POSIX alike file system
4140
- ftp: FTP and FTPS
4241
- http: HTTP read-only services
4342
- sftp: [SFTP](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02) services *being worked on*
@@ -60,8 +59,9 @@ Major components of the project include:
6059
</details>
6160

6261
<details>
63-
<summary>File Storage Services (like azdfs, hdfs)</summary>
62+
<summary>File Storage Services (like fs, azdfs, hdfs)</summary>
6463

64+
- fs: POSIX alike file system
6565
- azdfs: [Azure Data Lake Storage Gen2](https://azure.microsoft.com/en-us/products/storage/data-lake-storage/) services (As known as [abfs](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-abfs-driver))
6666
- hdfs: [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS)
6767
- ipfs: [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway

scripts/README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,7 @@
33
This module provides scripts to make maintainers lives easier.
44
OpenDAL users don't need to care about this folder.
55

6-
NOTES: all shell must be running at root folder of OpenDAL project.
7-
8-
## Generate NOTICE
9-
10-
```shell
11-
./scripts/generate_notice.sh
12-
```
6+
NOTES: all scripts must be running at root folder of OpenDAL project.
137

148
## Release
159

website/docs/contributing/reference/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717

18-
position: 2
18+
position: 100
1919
label: 'Reference'
2020
collapsible: true
2121
collapsed: true

website/docs/contributing/reference/verify_a_release_candidate.md renamed to website/docs/contributing/verify.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Verify a release candidate
2+
title: Verify
3+
sidebar_position: 2
34
---
45

56
To verify a release candidate, the following checklist could be used:
@@ -31,7 +32,7 @@ svn co https://dist.apache.org/repos/dist/dev/opendal/${release_version}-${rc_ve
3132

3233
## Checksums and signatures
3334

34-
The release candidate should have a checksum and signature file.
35+
The release candidate should have a checksum and signature file.
3536

3637
For example, if the release candidate is `0.36.0-rc1`, the checksum and signature file should be:
3738

@@ -87,9 +88,9 @@ Please decide how far you trust this user to correctly verify other users' keys
8788

8889
Select `5` to trust the key ultimately.
8990

90-
Now, we could start the verification.
91+
Now, we could start the verification.
9192

92-
We've provided a script to verify the checksum and signature of the release candidate.
93+
We've provided a script to verify the checksum and signature of the release candidate.
9394

9495
The script is in the `scripts` directory of our repository.
9596
You can download it directly from [here](https://raw.githubusercontent.com/apache/incubator-opendal/main/scripts/check.sh)
@@ -126,5 +127,3 @@ Unzip `apache-opendal-${release_version}-${rc_version}-src.tar.gz` and check the
126127
- LICENSE and NOTICE files are correct for the repository.
127128
- All files have ASF license headers if necessary.
128129
- Building is OK.
129-
130-

website/src/components/HomepageFeatures/_feature_services.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Apache OpenDAL provides native support for all kinds for storage systems.
33
<details>
44
<summary>Standard Storage Protocols</summary>
55

6-
- fs: POSIX alike file system
76
- ftp: FTP and FTPS
87
- http: HTTP read-only services
98
- sftp: [SFTP](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02) services *being worked on*
@@ -27,6 +26,7 @@ Apache OpenDAL provides native support for all kinds for storage systems.
2726
<details>
2827
<summary>File Storage Services</summary>
2928

29+
- fs: POSIX alike file system
3030
- azdfs: [Azure Data Lake Storage Gen2](https://azure.microsoft.com/en-us/products/storage/data-lake-storage/) services (As known as [abfs](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-abfs-driver))
3131
- hdfs: [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS)
3232
- ipfs: [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway

0 commit comments

Comments
 (0)