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

refactor: Implement new site structure #180

Merged
merged 28 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
8e012c8
Add new category Getting started
programmiri Feb 1, 2024
c4d2b34
Add new category Dashboard
programmiri Feb 1, 2024
cb7e2f2
Add new category Setup and configuration
programmiri Feb 2, 2024
c654f1f
Add new category User and team management
programmiri Feb 2, 2024
aeb2f86
Add new category Authentication and authorization
programmiri Feb 2, 2024
fa666f3
Add new category Cluster management
programmiri Feb 2, 2024
16d9070
Add new category Cluster connectivity
programmiri Feb 2, 2024
ef940e1
Add new category Connector management
programmiri Feb 2, 2024
ffa391b
Add new category Metadata management
programmiri Feb 2, 2024
179f772
Add new category Klaw workflows
programmiri Feb 2, 2024
9de7c36
Add new category Notifications
programmiri Feb 5, 2024
b5e058b
Remove unused directories.
programmiri Feb 5, 2024
a0f7781
Move workflows.md as index page for workflows category.
programmiri Feb 5, 2024
5d38fa1
Remove unnecessary doc synchronize.md
programmiri Feb 5, 2024
0ce5e5b
Move doc deployklaw.md
programmiri Feb 5, 2024
4c09d21
Move dashboard view page.
programmiri Feb 5, 2024
bc25454
Clean up sidebar.js
programmiri Feb 5, 2024
c601118
Rename dashboard page to not match category name.
programmiri Feb 5, 2024
78019ef
Remove unneeded sidebar positions.
programmiri Feb 5, 2024
43e3e92
Remove autogenerated indexes from docs.
programmiri Feb 5, 2024
27e4dba
Add script to check sidebar is complete.
programmiri Feb 5, 2024
9b63dcd
Move all scripts in one directory.
programmiri Feb 5, 2024
7438102
Document script to check sidebar.
programmiri Feb 5, 2024
6d1c0b6
Move consumer lag, topic event and reset consumer offsets docs to wor…
programmiri Feb 5, 2024
931849f
Add zothers text to features.md
programmiri Feb 5, 2024
74b724e
Format and update redirects file
programmiri Feb 5, 2024
6def9fc
Update script for markdown-link-checker
programmiri Feb 5, 2024
26ea9e6
Fix broken links.
programmiri Feb 5, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/link-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ jobs:
run: pnpm install

- name: Run markdown link check
run: pnpm markdown-link-check -- -q -o
run: pnpm markdown-link-check -q -o
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Here are the important ones you're likely to use:
- Run `pnpm markdown-link-check -- -o` to only check for internal links (offline mode).
- Run `pnpm markdown-link-check -- -q` to only log errors.
- Run `pnpm markdown-link-check -- -q /path/your-file.md` to run checks for only one file.
- `pnpm check-sidbar`: checks that the file linked in sidebar do exist and that all markdown files in `docs` are listed in sidebar.js. It does not warn for files that start with the prefix `DRAFT_`.

For these scripts, you need to have Vale installed (see [Requirements](#requirements)):

Expand Down
122 changes: 118 additions & 4 deletions _redirects
Original file line number Diff line number Diff line change
@@ -1,5 +1,119 @@
/docs/category/Releases/* /docs/releases/:splat 301
/docs/category/Releases /docs/releases 301
/docs/category/Releases/* /docs/releases/:splat 301
/docs/category/Releases /docs/releases 301


/docs/category/concepts /docs/Concepts/clusters-environments 301
/docs/category/howto /docs/HowTo/analytics 301


/docs/features /docs/getting-started/features 301
/docs/getstarted /docs/getting-started/getstarted 301
/docs/quickstart /docs/getting-started/quickstart 301
/docs/HowTo/zothers /docs/getting-started/features 301


/docs/HowTo/analytics /docs/dashboard/analytics 301
/docs/HowTo/dashboard /docs/dashboard/dashboard-view 301


/docs/HowTo/installation /docs/setup-configuration/klaw-installation 301
/docs/HowTo/installation/configure-klaw-wizard /docs/setup-configuration/klaw-installation/configure-klaw-wizard 301
/docs/HowTo/installation/run-docker /docs/setup-configuration/klaw-installation/run-docker 301
/docs/HowTo/installation/run-source /docs/setup-configuration/klaw-installation/run-source 301
/docs/HowTo/deployklaw /docs/setup-configuration/klaw-installation/deployklaw 301
/docs/HowTo/kafka-cluster-migration/tenant-config /docs/setup-configuration/tenant-configuration 301
/docs/HowTo/tenant /docs/setup-configuration/tenant-configuration 301


/docs/Concepts/config /docs/setup-configuration/klaw-api-ssl-with-kafka 301
/docs/Concepts/high-availability /docs/setup-configuration/high-availability 310
/docs/HowTo/settings /docs/setup-configuration/settings 310


/docs/Concepts/switch-teams /docs/user-team-management/teams/switch-teams 301
/docs/Concepts/users-teams /docs/user-team-management/users-roles-teams 301
/docs/HowTo/rolespermissions /docs/user-team-management/manage-roles-permissions 301
/docs/HowTo/teams/manage-teams /docs/user-team-management/teams/manage-teams 301
/docs/HowTo/users /docs/user-team-management/manage-users 301


/docs/HowTo/authentication/ /docs/authentication-authorization/authentication/azure-ad 301
/docs/HowTo/authentication/azure-ad /docs/authentication-authorization/authentication/azure-ad 301
/docs/HowTo/authentication/google-account /docs/authentication-authorization/authentication/google-account 301
/docs/HowTo/authentication/third-party-account /docs/authentication-authorization/authentication/third-party-account 301
/docs/HowTo/authentication/userpwd-db /docs/authentication-authorization/authentication/userpwd-db 301
/docs/HowTo/authentication/windows-ad /docs/authentication-authorization/authentication/windows-ad 301
/docs/HowTo/authorization /docs/authentication-authorization/authorization 301 301


/docs/Concepts/clusters-environments /docs/cluster-management/clusters-environments/ 301
/docs/HowTo/clusters /docs/cluster-management/clusters-environments/clusters 301
/docs/HowTo/environments /docs/cluster-management/clusters-environments/environments 301
/docs/HowTo/kafka-cluster-migration /docs/cluster-management/kafka-cluster-sync 301
/docs/Concepts/synchronize /docs/cluster-management/kafka-cluster-sync 301
/docs/HowTo/kafka-cluster-migration/sync-acls-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-from-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-acls-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-acls-to-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-connectors-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-connectors-from-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-topics-from-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-from-cluster 301
/docs/HowTo/kafka-cluster-migration/sync-topics-to-cluster /docs/cluster-management/kafka-cluster-sync/sync-topics-to-cluster 301


/docs/HowTo/clusterconnectivity/ /docs/cluster-connectivity-setup/ 301
/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-sasl-protocol 301
/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-cluster-ssl-protocol 301
/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-kafka-connect-cluster-ssl-protocol 301
/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol /docs/cluster-connectivity-setup/aiven-karapace-cluster-ssl-protocol 301
/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/confluent-cloud-kafka-cluster-ssl-protocol 301
/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-sasl-protocol 301
/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol /docs/cluster-connectivity-setup/kafka-cluster-ssl-protocol 301
/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi /docs/cluster-connectivity-setup/klaw-core-with-clusterapi 301
/docs/HowTo/clusterconnectivity/klaw-db-connection /docs/cluster-connectivity-setup/klaw-db-connection 301
/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol /docs/cluster-connectivity-setup/sr-cluster-ssl-protocol 301


/docs/HowTo/connectors /docs/connector-management 301
/docs/HowTo/connectors/Approve-a-connector /docs/connector-management/approve-connector 301
/docs/HowTo/connectors/manage-connectors /docs/connector-management/manage-connectors 301
/docs/HowTo/connectors/My-connector-requests /docs/connector-management/my-connector-requests 301
/docs/HowTo/connectors/Request-a-new-connector /docs/connector-management/request-connector 301


/docs/Concepts/metastore /docs/metadata-management/metastore 301
/docs/HowTo/exportimport/ /docs/metadata-management/import-export 301
/docs/HowTo/exportimport/exportdata /docs/metadata-management/import-export/exportdata 301
/docs/HowTo/exportimport/importdata /docs/metadata-management/import-export/importdata 301


/docs/Concepts/workflows /docs/workflows/ 301
/docs/Concepts/promotion /docs/workflows/promotion 301
/docs/HowTo/schemas /docs/workflows/schema 301
/docs/HowTo/schemas/manage-schemas /docs/workflows/schema/manage-schema-requests 301
/docs/HowTo/schemas/My-schema-requests /docs/workflows/schema/my-schema-requests 301
/docs/HowTo/schemas/Promote-a-schema /docs/workflows/schema/promote-schema 301
/docs/HowTo/schemas/Request-a-schema /docs/workflows/schema/request-schema 301
/docs/HowTo/subscriptions /docs/workflows/subscription 301
/docs/HowTo/subscriptions/Approve-a-subscription /docs/workflows/subscription/manage-subscription-requests 301
/docs/HowTo/subscriptions/Delete-a-subscription /docs/workflows/subscription/delete-subscription 301
/docs/HowTo/subscriptions/My-subscription-requests /docs/workflows/subscription/my-subscription-requests 301
/docs/HowTo/subscriptions/Request-a-subscription /docs/workflows/subscription/request-subscription 301
/docs/HowTo/topics/ /docs/workflows/topic 301
/docs/HowTo/topics/Approve-a-topic /docs/workflows/topic/manage-topic-requests 301
/docs/HowTo/topics/Claim-a-topic /docs/workflows/topic/claim-topic 301
/docs/HowTo/topics/Delete-a-topic /docs/workflows/topic/delete-topic 301
/docs/HowTo/topics/Edit-topic-request /docs/workflows/topic/edit-topic 301
/docs/HowTo/topics/My-topic-requests /docs/workflows/topic/my-topic-requests 301
/docs/HowTo/topics/Promote-a-topic /docs/workflows/topic/promote-topic 301
/docs/HowTo/topics/Request-a-new-topic /docs/workflows/topic/request-topic 301
/docs/HowTo/topics/Topic-overview /docs/workflows/topic/topic-overview 301
/docs/HowTo/topics/View-consumer-lag /docs/workflows/topic/view-consumer-lag 301
/docs/HowTo/topics/View-topic-events /docs/workflows/topic/view-topic-events 301
/docs/HowTo/operational/ /docs/workflows/topic/reset-consumer-offsets 301
/docs/HowTo/operational/Reset-Consumer-Offsets /docs/workflows/topic/reset-consumer-offsets 301


/docs/HowTo/notifications/ /docs/notifications/email-notification 301
/docs/HowTo/notifications/email-notification /docs/notifications/email-notification 301
/docs/HowTo/notifications/slack-notification /docs/notifications/slack-notification 301

/docs/category/concepts /docs/Concepts/clusters-environments 301
/docs/category/howto /docs/HowTo/analytics 301
6 changes: 3 additions & 3 deletions blog/2023/09/schema-management-disaster-recovery-in-klaw.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ As the topic owner, you have the authority to approve, initiate, or reject any s

![image](../../../static/images/blogimages/SchemaRequest-Workflow.png)

For more information on registering a schema **[see here](../../../docs/HowTo/schemas/Request-a-schema)**
For more information on registering a schema **[see here](/docs/workflows/schema/request-schema)**

Watch the video below for a step-by-step demonstration of registering a schema in Klaw.

Expand All @@ -158,7 +158,7 @@ with topics, and integrating them into its metastore. This backup process is str
clicks, regardless of the volume of schemas or topics.

For more information on synchronizing schemas from the schema registry to Klaw, refer to
**[sync-schemas-from-cluster](../../../docs/HowTo/kafka-cluster-migration/sync-schemas-from-cluster)**
**[sync-schemas-from-cluster](/docs/cluster-management/kafka-cluster-sync/sync-schemas-from-cluster)**

The following video demonstrates how schemas are synchronized to Klaw for a selection of topics already present in
Karapace.
Expand All @@ -176,7 +176,7 @@ Select the schemas you want to sync with the cluster. Once you submit your choic
schemas directly into your designated schema registry environment.

For more information on this synchronization process, refer to
**[sync-schemas-to-cluster](/docs/HowTo/kafka-cluster-migration/sync-schemas-to-cluster)**
**[sync-schemas-to-cluster](/docs/cluster-management/kafka-cluster-sync/sync-schemas-to-cluster)**

The following video demonstrates migrating schemas to a Schema Registry, specifically focusing on a couple of subjects
already stored in Klaw.
Expand Down
Loading
Loading