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

fix: a download page must use closer.lua to link to thw artifacts #744

Merged
merged 1 commit into from
Apr 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
25 changes: 12 additions & 13 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ const versions = require('./versions.json');
sidebarPath: require.resolve('./sidebarsLivedemo.js'),
},
],
[
'@docusaurus/plugin-content-docs',
{
id: 'download',
path: 'download',
routeBasePath: 'download',
sidebarPath: require.resolve('./sidebarsDownload.js'),
},
],
function tailwindcss() {
return {
name: 'docusaurus-tailwindcss',
Expand Down Expand Up @@ -201,19 +210,9 @@ const versions = require('./versions.json');
position: 'right',
},
{
type: 'dropdown',
to: '/download',
label: 'Download',
position: 'right',
items: [
{
label: 'Latest Release',
to: 'https://dist.apache.org/repos/dist/release/incubator/devlake',
},
{
label: 'Older Releases',
to: 'https://archive.apache.org/dist/incubator/devlake',
}
],
position: 'right'
},
{
type: 'dropdown',
Expand Down Expand Up @@ -330,7 +329,7 @@ const versions = require('./versions.json');
require.resolve('@easyops-cn/docusaurus-search-local'),
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
({
docsRouteBasePath: ['docs','livedemo', 'community', 'blog'],
docsRouteBasePath: ['docs','livedemo', 'community', 'blog', 'Download'],
hashed: true,
explicitSearchResultPath: true,
}),
Expand Down
42 changes: 42 additions & 0 deletions download/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Apache DevLake Downloads

The official Apache DevLake releases are provided as source artifacts.

## Releases

The latest source release is [0.21.0](
https://www.apache.org/dyn/closer.lua/incubator/devlake/0.21.0-incubating/apache-devlake-0.21.0-incubating-src.tar.gz?action=download) ([asc](https://downloads.apache.org/incubator/devlake/0.21.0-incubating/apache-devlake-0.21.0-incubating-src.tar.gz.asc),
[sha512](https://downloads.apache.org/incubator/devlake/0.21.0-incubating/apache-devlake-0.21.0-incubating-src.tar.gz.sha512)).

For older releases, please check the [archive](https://archive.apache.org/dist/incubator/devlake).

## Notes

* When downloading a release, please verify the OpenPGP compatible signature (or failing that, check the SHA-512); these should be fetched from the main Apache site.
* The KEYS file contains the public keys used for signing release. It is recommended that (when possible) a web of trust is used to confirm the identity of these keys.
* Please download the [KEYS](https://downloads.apache.org/incubator/devlake/KEYS) as well as the .asc signature files.

### To verify the signature of the release artifact

You will need to download both the release artifact and the .asc signature file for that artifact. Then verify the signature by:

* Download the KEYS file and the .asc signature files for the relevant release artifacts.
* Import the KEYS file to your GPG keyring:

```shell
gpg --import KEYS
```

* Verify the signature of the release artifact using the following command:

```shell
gpg --verify <artifact>.asc <artifact>
```

### To verify the checksum of the release artifact

You will need to download both the release artifact and the .sha512 checksum file for that artifact. Then verify the checksum by:

```shell
shasum -a 512 -c <artifact>.sha512
```
29 changes: 29 additions & 0 deletions sidebarsDownload.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
downloadSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
/*
tutorialSidebar: [
{
type: 'category',
label: 'Tutorial',
items: ['hello'],
},
],
*/
};

module.exports = sidebars;
Loading