diff --git a/docs/advanced-usage/_category_.json b/docs/composing/_category_.json similarity index 72% rename from docs/advanced-usage/_category_.json rename to docs/composing/_category_.json index 97d1339..03c4661 100644 --- a/docs/advanced-usage/_category_.json +++ b/docs/composing/_category_.json @@ -1,6 +1,6 @@ { - "label": "Advanced Usage", - "position": 5, + "label": "Composing", + "position": 3, "link": { "type": "generated-index", "description": "Learn more advanced techniques to use protoconf." diff --git a/docs/advanced-usage/code-reuse.mdx b/docs/composing/code-reuse.mdx similarity index 100% rename from docs/advanced-usage/code-reuse.mdx rename to docs/composing/code-reuse.mdx diff --git a/docs/advanced-usage/multiple-outputs.mdx b/docs/composing/multiple-outputs.mdx similarity index 100% rename from docs/advanced-usage/multiple-outputs.mdx rename to docs/composing/multiple-outputs.mdx diff --git a/docs/advanced-usage/mutation-service/grpc.mdx b/docs/composing/mutation-service/grpc.mdx similarity index 100% rename from docs/advanced-usage/mutation-service/grpc.mdx rename to docs/composing/mutation-service/grpc.mdx diff --git a/docs/advanced-usage/mutation-service/mutation-cli.mdx b/docs/composing/mutation-service/mutation-cli.mdx similarity index 100% rename from docs/advanced-usage/mutation-service/mutation-cli.mdx rename to docs/composing/mutation-service/mutation-cli.mdx diff --git a/docs/advanced-usage/mutation-service/mutation-service.mdx b/docs/composing/mutation-service/mutation-service.mdx similarity index 100% rename from docs/advanced-usage/mutation-service/mutation-service.mdx rename to docs/composing/mutation-service/mutation-service.mdx diff --git a/docs/advanced-usage/mutation-service/reflection.mdx b/docs/composing/mutation-service/reflection.mdx similarity index 100% rename from docs/advanced-usage/mutation-service/reflection.mdx rename to docs/composing/mutation-service/reflection.mdx diff --git a/docs/advanced-usage/output-formats.mdx b/docs/composing/output-formats.mdx similarity index 100% rename from docs/advanced-usage/output-formats.mdx rename to docs/composing/output-formats.mdx diff --git a/docs/advanced-usage/pipelining.mdx b/docs/composing/pipelining.mdx similarity index 100% rename from docs/advanced-usage/pipelining.mdx rename to docs/composing/pipelining.mdx diff --git a/docs/advanced-usage/protobuf-any.mdx b/docs/composing/protobuf-any.mdx similarity index 100% rename from docs/advanced-usage/protobuf-any.mdx rename to docs/composing/protobuf-any.mdx diff --git a/docs/advanced-usage/starlib.mdx b/docs/composing/starlib.mdx similarity index 100% rename from docs/advanced-usage/starlib.mdx rename to docs/composing/starlib.mdx diff --git a/docs/consuming/_category_.json b/docs/consuming/_category_.json new file mode 100644 index 0000000..4d6e0ea --- /dev/null +++ b/docs/consuming/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Consuming", + "position": 5 +} \ No newline at end of file diff --git a/docs/production/running-in-production.mdx b/docs/consuming/running-in-production.mdx similarity index 100% rename from docs/production/running-in-production.mdx rename to docs/consuming/running-in-production.mdx diff --git a/docs/delivering/_category_.json b/docs/delivering/_category_.json new file mode 100644 index 0000000..466ccb5 --- /dev/null +++ b/docs/delivering/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Delivering", + "position": 4 +} \ No newline at end of file diff --git a/docs/production/inserting-configurations.mdx b/docs/delivering/inserting-configurations.mdx similarity index 100% rename from docs/production/inserting-configurations.mdx rename to docs/delivering/inserting-configurations.mdx diff --git a/docs/consume-config-updates.mdx b/docs/getting-started/consume-config-updates.mdx similarity index 96% rename from docs/consume-config-updates.mdx rename to docs/getting-started/consume-config-updates.mdx index ed13340..87a4e29 100644 --- a/docs/consume-config-updates.mdx +++ b/docs/getting-started/consume-config-updates.mdx @@ -13,21 +13,19 @@ protoconf provides a gRPC service that allows your application to subscribe to c This guide will walk you through how to subscribe to configuration updates using the protoconf agent in various languages: Go, Python, Node.js, Rust, and Java. -## protoconf Agent +## protoconf Dev server -To start the protoconf agent in development mode, use the following command: +To start protoconf in development mode, use the following command: ```bash -protoconf agent -dev . +protoconf devserver . ``` -The protoconf agent implements the following gRPC service: +The protoconf agent implements the following gRPC service ([See full proto file](https://github.com/protoconf/protoconf/blob/main/pb/protoconf/v1/protoconf.proto#L66)): ```protobuf syntax = "proto3"; -package v1; - -option java_package = "com.protoconf.agent.api.v1"; +package protoconf.v1; import "google/protobuf/any.proto"; diff --git a/docs/getting-started.mdx b/docs/getting-started/getting-started.mdx similarity index 100% rename from docs/getting-started.mdx rename to docs/getting-started/getting-started.mdx diff --git a/docs/production/production-architecture.mdx b/docs/getting-started/production-architecture.mdx similarity index 98% rename from docs/production/production-architecture.mdx rename to docs/getting-started/production-architecture.mdx index cb75632..95f3d52 100644 --- a/docs/production/production-architecture.mdx +++ b/docs/getting-started/production-architecture.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 4 --- # Production Architecture diff --git a/docs/validation.mdx b/docs/getting-started/validation.mdx similarity index 100% rename from docs/validation.mdx rename to docs/getting-started/validation.mdx diff --git a/docs/production/_category_.json b/docs/production/_category_.json deleted file mode 100644 index ef062a3..0000000 --- a/docs/production/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Running in Production", - "position": 6, -} \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 40cf997..65192a5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -53,6 +53,9 @@ const config = { versions: { current: { label: 'v0.2.0', + }, + "0.1.7": { + label: 'v0.1.7', } } }, @@ -83,6 +86,12 @@ const config = { srcDark: 'img/protoconf_inverse.png', }, items: [ + { + type: 'doc', + docId: 'getting-started/getting-started', + position: 'left', + label: 'Get Started', + }, { type: 'doc', docId: 'intro', @@ -146,7 +155,7 @@ const config = { items: [ { label: 'Tutorial', - to: 'docs/0.1.7/intro', + to: 'docs/intro', }, ], }, diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 44d9384..e65b628 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -17,7 +17,7 @@ function HomepageHeader() {