Skip to content

docs: Move verify to upper folder #2546

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 26, 2023
Merged

docs: Move verify to upper folder #2546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ Major components of the project include:
**Services**

<details>
<summary>Standard Storage Protocols (like fs, ftp)</summary>
<summary>Standard Storage Protocols (like ftp, webdav)</summary>

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

<details>
<summary>File Storage Services (like azdfs, hdfs)</summary>
<summary>File Storage Services (like fs, azdfs, hdfs)</summary>

- fs: POSIX alike file system
- 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))
- hdfs: [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS)
- ipfs: [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway
Expand Down
8 changes: 1 addition & 7 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,7 @@
This module provides scripts to make maintainers lives easier.
OpenDAL users don't need to care about this folder.

NOTES: all shell must be running at root folder of OpenDAL project.

## Generate NOTICE

```shell
./scripts/generate_notice.sh
```
NOTES: all scripts must be running at root folder of OpenDAL project.

## Release

Expand Down
2 changes: 1 addition & 1 deletion website/docs/contributing/reference/_category_.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# specific language governing permissions and limitations
# under the License.

position: 2
position: 100
label: 'Reference'
collapsible: true
collapsed: true
Expand Down
11 changes: 5 additions & 6 deletions ...g/reference/verify_a_release_candidate.md → website/docs/contributing/verify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Verify a release candidate
title: Verify
sidebar_position: 2
---

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

## Checksums and signatures

The release candidate should have a checksum and signature file.
The release candidate should have a checksum and signature file.

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

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

Select `5` to trust the key ultimately.

Now, we could start the verification.
Now, we could start the verification.

We've provided a script to verify the checksum and signature of the release candidate.
We've provided a script to verify the checksum and signature of the release candidate.

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


2 changes: 1 addition & 1 deletion website/src/components/HomepageFeatures/_feature_services.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ Apache OpenDAL provides native support for all kinds for storage systems.
<details>
<summary>Standard Storage Protocols</summary>

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

- fs: POSIX alike file system
- 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))
- hdfs: [Hadoop Distributed File System](https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)(HDFS)
- ipfs: [InterPlanetary File System](https://ipfs.tech/) HTTP Gateway
Expand Down