Skip to content

Commit

Permalink
fix: fluvio.io doc linkss from various README.md and other docs (#4141)
Browse files Browse the repository at this point in the history
* fix: README.md links

* fix: other *.md links to fluvio.io docs
  • Loading branch information
digikata authored Aug 17, 2024
1 parent 898c22e commit b5979a0
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 36 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1028,7 +1028,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
* Check if the local cluster exists during installation ([#2041](https://github.com/infinyon/fluvio/issues/2041))

> Note:
> For existing CLI users, we recommend following [the instructions to re-install their CLI](https://www.fluvio.io/download/). This is a requirement in order to use Fluvio CLI Channels.
> For existing CLI users, we recommend following [the instructions to re-install their CLI](https://www.fluvio.io/docs/fluvio/fvm/introduction). This is a requirement in order to use Fluvio CLI Channels.
## Platform Version 0.9.15 - 2021-12-10
* Migrate Rust crates to edition 2021 ([#1798](https://github.com/infinyon/fluvio/issues/1798))
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Familiarity with

Currently, fluvio supports the following platforms:
- macOS X
- Linux
- Linux
- Other platforms such as Windows can be made to work, but we haven't tried them yet.

## Ask a Question
Expand All @@ -28,9 +28,9 @@ Please open an Issue on GitHub with the label `question`.

## Getting Started

Follow our [Download Fluvio](https://www.fluvio.io/download/) and the corresponding "Get Started" page to get fluvio up and running.
Follow our [Download Fluvio](https://www.fluvio.io/docs/fluvio/quickstart) and the corresponding "Get Started" page to get fluvio up and running.

To learn about the Fluvio Architecture and contribute to Fluvio project, please visit the [Architecture](https://www.fluvio.io/docs/architecture/overview/) section.
To learn about the Fluvio Architecture and contribute to Fluvio project, please visit the [Architecture](https://www.fluvio.io/docs/fluvio/concepts/architecture/overview/) section.

## Contributing

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ Now that you have a cluster running you can try building data flows in different

#### Check Fluvio Core Documentation
Fluvio documentation will provide additional context on how to use the Fluvio clusters, CLI, clients, a development kits.
- [Fluvio docs home](https://www.fluvio.io/docs/)
- [Fluvio CLI docs home](https://www.fluvio.io/cli/)
- [Fluvio Architecture](https://www.fluvio.io/docs/architecture/overview/)
- [Fluvio docs home](https://www.fluvio.io)
- [Fluvio CLI docs home](https://www.fluvio.io/docs/fluvio/cli/overview)
- [Fluvio Architecture](https://www.fluvio.io/docs/fluvio/concepts/architecture/overview)

#### Learn how to build custom connectors
Fluvio can connect to practically any system that you can think of.
Expand All @@ -108,14 +108,14 @@ Fluvio can connect to practically any system that you can think of.
Out of the box Fluvio has native http, webhook, mqtt, kafka inbound connectors. In terms of outbound connectors out of the box Fluvio supports SQL, DuckDB, Graphite, experimental builds of Redis, S3 etc.

Using Connector Development Kit, we built our existing connectors in a matter of few days. Check out the docs and let us know if you need help building any connector.
- [Connector docs](https://www.fluvio.io/connectors/)
- [Connector Development Kit docs](https://www.fluvio.io/connectors/cdk/overview/)
- [Connector docs](https://www.fluvio.io/docs/connectors/overview)
- [Connector Development Kit (cdk) docs](https://www.fluvio.io/docs/connectors/cdk)

#### Learn how to build custom smart modules
Fluvio applies wasm based stream processing and data transformations. We call these reusable transformation functions smart modules. Reusable Smart modules are built using Smart Module Development Kit and can be distributed using InfinyOn Cloud hub.

- [Smart Modules docs](https://www.fluvio.io/smartmodules/)
- [Smart Modules Development Kit docs](https://www.fluvio.io/smartmodules/)
- [Smart Modules docs](https://www.fluvio.io/docs/smartmodules/overview)
- [Smart Modules Development Kit (smdk) docs](https://www.fluvio.io/docs/smartmodules/smdk)

There are some limitations on the amount of polyglot development interface support. While bindings can be generated for wasm compatible languages, there are quirks in that approach. We have a better solution with Stateful Service Development Kit, which we are implementing using the web assembly component model. In the upcoming releases we will be able to natively support all wasm compatible programming languages.

Expand All @@ -127,7 +127,7 @@ InfinyOn Cloud is Fluvio on the cloud as a managed service. All new users get $3
- [Check out experimental data flows on InfinyOn Labs Repo](https://github.com/infinyon/labs-projects)

### Clients
- [Fluvio Client API docs home](https://www.fluvio.io/api/)
- [Fluvio Client API docs home](https://www.fluvio.io/docs/fluvio/apis/overview)

**Language Specifc API docs:**
- [Rust API docs](https://docs.rs/fluvio/latest/fluvio/)
Expand Down
24 changes: 8 additions & 16 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,10 @@ Create a [new issue](https://github.com/infinyon/fluvio/issues/new?template=rele
Prior to releasing, the release manager should check the following:

Review Fluvio website:
1. Review the "Getting Started" docs.
- [ ] https://www.fluvio.io/docs/get-started/linux/
- [ ] https://www.fluvio.io/docs/get-started/mac/
- [ ] https://www.fluvio.io/docs/get-started/raspberry/
- [ ] https://www.fluvio.io/docs/get-started/cloud/
2. Sample code is correct (API docs are correct)
- [ ] https://www.fluvio.io/api/official/rust/examples/
- [ ] https://www.fluvio.io/api/official/python/examples/
- [ ] https://www.fluvio.io/api/official/node/examples/
- [ ] https://www.fluvio.io/api/official/java/examples/
3. Review rest of doc to ensure they are up to date.
- [ ] https://www.fluvio.io/docs/
1. Review the "Quickstart" docs.
- [ ] https://www.fluvio.io/docs/fluvio/quickstart
2. Review docs for key changes to ensure they are up to date.
- [ ] https://www.fluvio.io

Other dependent repos:
- [ ] Update [`infinyon/fluvio-smartmodule-template`](https://github.com/infinyon/fluvio-smartmodule-template) if needed.
Expand Down Expand Up @@ -71,7 +63,7 @@ Release the connector for the new version of Fluvio in: https://github.com/infin
If there is no major changes in the connector, then only patch or minor version should be updated.
## Post-release workflow

This is a mostly **manual** workflow
This is a mostly **manual** workflow

After performing the release, the release manager should do the following in order
to prepare for the next release and announce the current release to the community:
Expand All @@ -81,7 +73,7 @@ to prepare for the next release and announce the current release to the communit
- Update `VERSION` file for next release
- [ ] Minor version bump the version in the `VERSION` file with `-dev-1`. For example, if release was `0.10.1` then version should be bump to `0.10.2-dev-1`.
- Update `CHANGELOG.md` file for next release
- [ ] Add Platform version section (matching value as `VERSION` file) with a release date of `UNRELEASED` to
- [ ] Add Platform version section (matching value as `VERSION` file) with a release date of `UNRELEASED` to
`CHANGELOG.md` at top of file (but under the `# Release Notes` header)
- ```## Platform Version X.Y.Z - UNRELEASED```
- [ ] For version just released, replace `UNRELEASED` date with current date (format as `YYYY-MM-dd`) in `CHANGELOG.md`.
Expand Down Expand Up @@ -114,7 +106,7 @@ In the event that the release automation fails, there is manual cleanup required
### Delete artifacts:
- Docker Hub
- Delete the image tag corresponding to the release VERSION
- Delete the image tag corresponding to the release VERSION
- S3
- Delete the version directory for `fluvio` and `fluvio-run` artifacts
- s3://packages.fluvio.io/v1/packages/fluvio/fluvio/<VERSION>
Expand All @@ -127,7 +119,7 @@ In the event that the release automation fails, there is manual cleanup required
- `fluvio install fluvio-package`
- `fluvio package tag fluvio:x.y.z --tag=stable --force`
- Remove last entry in fluvio-run meta.json
- s3://packages.fluvio.io/v1/packages/fluvio/fluvio-run/meta.json
- s3://packages.fluvio.io/v1/packages/fluvio/fluvio-run/meta.json
- This should be a regular release tag (x.y.z), not a dev tag (x.y.z+gitcommit)
- Confirm that the installation script works
- `curl -fsS https://hub.infinyon.cloud/install/install.sh | bash`
Expand Down
10 changes: 5 additions & 5 deletions crates/fluvio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![CI Status](https://github.com/infinyon/fluvio/workflows/CI/badge.svg)](https://github.com/infinyon/fluvio/actions/workflows/ci.yml)
[![CD Status](https://github.com/infinyon/fluvio/workflows/CD_Dev/badge.svg)](https://github.com/infinyon/fluvio/actions/workflows/cd_dev.yaml)
[![fluvio Crates.io version](https://img.shields.io/crates/v/fluvio?style=flat)](https://crates.io/crates/fluvio)
[![Fluvio Rust documentation](https://docs.rs/fluvio/badge.svg)](https://docs.rs/fluvio)
[![Fluvio client API documentation](https://docs.rs/fluvio/badge.svg)](https://docs.rs/fluvio)
[![Fluvio dependency status](https://deps.rs/repo/github/infinyon/fluvio/status.svg)](https://deps.rs/repo/github/infinyon/fluvio)
[![Fluvio Discord](https://img.shields.io/discord/695712741381636168.svg?logo=discord&style=flat)](https://discordapp.com/invite/bBG2dTz)

Expand Down Expand Up @@ -132,7 +132,7 @@ topic "echo-test" deleted
- If you want to filter or transform records on the fly read more about [SmartModules][SmartModules].

[Fluvio.io]: https://www.fluvio.io
[Install Fluvio CLI]: https://www.fluvio.io/cli/
[Connectors]: https://www.fluvio.io/connectors/
[SmartModules]: https://www.fluvio.io/smartmodules/
[Tutorials]: https://www.fluvio.io/docs/tutorials/cloud-setup/
[Install Fluvio CLI]: https://www.fluvio.io/docs/fluvio/cli/overview
[Connectors]: https://www.fluvio.io/docs/connectors/overview
[SmartModules]: https://www.fluvio.io/docs/smartmodules/overview
[Tutorials]: https://www.fluvio.io/docs/cloud/tutorials/
4 changes: 2 additions & 2 deletions examples/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ docker compose down
> Remember to run this command in the same directory as the `docker-compose.yml`
> file.
[1]: https://www.fluvio.io/docs/architecture/overview/
[2]: https://www.fluvio.io/cli/
[1]: https://www.fluvio.io/docs/fluvio/concepts/architecture/overview/
[2]: https://www.fluvio.io/docs/fluvio/cli/overview
2 changes: 1 addition & 1 deletion smartmodule/cargo_template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This filter will keep only records whose data contains the letter `z`.
Make sure to follow the [Fluvio getting started] guide, then create a new
topic to send data to.

[Fluvio getting started]: https://www.fluvio.io/docs/getting-started/
[Fluvio getting started]: https://www.fluvio.io/docs/fluvio/quickstart

```bash
$ fluvio topic create smartmodule-test
Expand Down

0 comments on commit b5979a0

Please sign in to comment.