Skip to content

Commit

Permalink
revert: versioning setup (#58)
Browse files Browse the repository at this point in the history
Disable versioning in order to introduce changes in NavBar as requested
on #52.
After reorganization, versions are going to be reintroduced.

More details on the issue are here:
facebook/docusaurus#4985

To simplify source Im removing, then applying organizational changes and
finally I will reintroduce.
  • Loading branch information
EstebanBorai authored Jun 20, 2024
1 parent 56b2f6e commit cdc0492
Show file tree
Hide file tree
Showing 158 changed files with 3 additions and 17,895 deletions.
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<div align="center">
<h1>InfinyOn Documentation</h1>
<strong>Omni-docs for InfinyOn Solutions</strong>
<a href="https://fluvio.io" target="_blank">
<strong>Omni-docs for InfinyOn Solutions</strong>
</a>
</div>

## Contributing
Expand Down Expand Up @@ -38,36 +40,3 @@ $ npm run build && npm run serve

The `build` command generates static content into the `build` directory and
can be served using any static contents hosting service.

## Documentation Management

### Drafting new Versions

Versions are drafted using the Docusaurus CLI. To create a new version, run the
following command:

```bash
$ npm run docusaurus docs:version <VERSION>
```

This command will:

- Copy the full `docs/` folder contents into a new `versioned_docs/version-[versionName]/` folder.
- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as `versioned_sidebars/version-[versionName]-sidebars.json`.
- Append the new version number to `versions.json`.

Then make sure to update the versions settings under `docusaurus.config.ts` file.

```ts
lastVersion: '0.11.9', // Last Released Version
versions: {
current: {
label: '0.11.10', // Current Version (Draft)
path: '0.11.10',
},
},
```

> [!IMPORTANT]
> Run this command when a new Fluvio Version is released in order to freeze the
> documentation for the previous version.
10 changes: 0 additions & 10 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,7 @@ const config: Config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/infinyon/fluvio-docs/tree/main",
showLastUpdateAuthor: true,
showLastUpdateTime: true,
lastVersion: '0.11.9',
versions: {
current: {
label: '0.11.10',
path: '0.11.10',
},
},
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
},
Expand Down
121 changes: 0 additions & 121 deletions versioned_docs/version-0.11.9/apis/index.mdx

This file was deleted.

109 changes: 0 additions & 109 deletions versioned_docs/version-0.11.9/apis/java/example.mdx

This file was deleted.

Loading

0 comments on commit cdc0492

Please sign in to comment.