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

Remove downloads page from website #534

Merged
merged 1 commit into from
Sep 11, 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
30 changes: 0 additions & 30 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,27 +60,6 @@ npm run serve
> [!NOTE]
> If you make changes to the contents inside `docs` directory, you can verify the changes locally by visiting https://localhost:3000/docs/setup after running `npm run serve`.

## Creating new pages with navbar access
1. Create a new folder i.e. `releases` inside the `website` directory
2. Create a new file i.e. `downloads.mdx` inside the `releases` directory
3. Add necessary content to the markdown file
4. Include the reference to the new folder in the `docusaurus.config.js` file as follows:
* Add the new folder to the `plugins` array under `config` key, like
```javascript
[
'@docusaurus/plugin-content-docs',
{
id: 'releases',
path: 'releases',
routeBasePath: 'releases',
},
]
```
* Add the new folder to the `items` array under `navbar` key, like
```javascript
{to: 'releases/downloads', label: 'Downloads', position: 'left'}
```

## Docs
### Creating new docs
1. Place the new file into the `docs` folder.
Expand All @@ -100,15 +79,6 @@ npm run serve
> [!NOTE]
> You may see broken thumbnails for the blogs during `npm start` or `npm serve` because the images needs to be rendered from the main repo. This can only be tested after being merged to the main branch.

## Releases
### Adding new release
1. Create a `.mdx` file similar to `website/releases/release-0.1.0-incubating.mdx`
2. Update the [downloads](releases/downloads.mdx) file to include the new release similar to the existing releases

## Changes to the website homepage
1. The homepage is a `.html` file located at `website/static/index.html`
2. If you're making changes to the page, test it locally using `python 3 -m http.server` and visiting http://localhost:8000/ before pushing the changes.


## Maintainers
[Apache XTable™ (Incubating) Community](https://incubator.apache.org/projects/xtable.html)
13 changes: 0 additions & 13 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,6 @@ const config = {
locales: ['en'],
},

// add new pages here
plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'releases',
path: 'releases',
routeBasePath: 'releases',
},
],
],

presets: [
[
'classic',
Expand Down Expand Up @@ -77,7 +65,6 @@ const config = {
position: 'right',
},
{to: 'blog', label: 'Blogs', position: 'left'},
{to: 'releases/downloads', label: 'Downloads', position: 'left'},
],
},
prism: {
Expand Down
14 changes: 0 additions & 14 deletions website/releases/downloads.mdx

This file was deleted.

33 changes: 0 additions & 33 deletions website/releases/release-0.1.0-incubating.mdx

This file was deleted.

5 changes: 1 addition & 4 deletions website/static/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@
<nav role="navigation" class="nav-menu w-nav-menu">
<a href="#" class="nav-link w-nav-link">Home</a>
<a href="https://xtable.apache.org/docs/setup/" class="nav-link w-nav-link">Docs</a>
<a href="https://xtable.apache.org/blog" class="nav-link w-nav-link">Blogs</a>
<a href="https://xtable.apache.org/releases/downloads" class="nav-link w-nav-link">Downloads</a>
<img src="images/break.svg" loading="lazy" alt="" class="image-10">
<a href="https://xtable.apache.org/blog" class="nav-link w-nav-link">Blogs</a><img src="images/break.svg" loading="lazy" alt="" class="image-10">
<a href="https://github.com/apache/incubator-xtable" class="nav-icon-link1 w-inline-block"><img src="images/Github.svg" loading="lazy" alt=""></a>
<a href="https://www.linkedin.com/company/apache-xtable/" class="nav-icon-link1 w-inline-block"><img src="images/linkedin.svg" loading="lazy" alt=""></a>
<a href="https://twitter.com/apachextable" class="nav-icon-link1 w-inline-block"><img src="images/twitter.svg" loading="lazy" alt=""></a>
Expand All @@ -52,7 +50,6 @@
<a href="#" class="nav-link-copy w-nav-link">Home</a>
<a href="https://xtable.apache.org/docs/setup/" class="nav-link-copy w-nav-link">Docs</a>
<a href="https://xtable.apache.org/blog" class="nav-link-copy w-nav-link">Blogs</a>
<a href="https://xtable.apache.org/releases/downloads" class="nav-link-copy w-nav-link">Downloads</a>
<a href="https://github.com/apache/incubator-xtable" class="nav-link-copy w-nav-link">GitHub</a>
<a href="#" class="nav-link-copy w-nav-link">LinkedIn</a>
<a href="#" class="nav-link-copy w-nav-link">Twitter</a>
Expand Down