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

Update docs #410

Closed
sujuka99 opened this issue Jan 12, 2024 · 0 comments
Closed

Update docs #410

sujuka99 opened this issue Jan 12, 2024 · 0 comments
Assignees
Labels
area/documentation Improvements or additions to documentation good first issue Good for newcomers high priority Prioritised issues
Milestone

Comments

@sujuka99
Copy link
Contributor

sujuka99 commented Jan 12, 2024

  1. https://github.com/bakdata/kpops/blob/v3/docs/docs/resources/pipeline-config/config.yaml#L19-L21
- default_output_topic_name: ${pipeline.name}-${component_name}
+ default_output_topic_name: ${pipeline.name}-${component.name}
  # Configures the value for the variable ${error_topic_name}
- default_error_topic_name: ${pipeline.name}-${component_name}-error
+ default_error_topic_name: ${pipeline.name}-${component.name}-error
  1. https://github.com/bakdata/kpops/blob/v3/docs/docs/user/core-concepts/variables/substitution.md?plain=1#L29-L30
-   `error_topic_name` is an alias for `topic_name_config.default_error_topic_name`  
+   `error_topic_name` is an alias for `config.topic_name_config.default_error_topic_name`  
-   `output_topic_name` is an alias for `topic_name_config.default_output_topic_name`
+   `output_topic_name` is an alias for `config.topic_name_config.default_output_topic_name`
  1. https://github.com/bakdata/kpops/blob/v3/docs/docs/user/core-concepts/variables/substitution.md?plain=1#L24

Mention the prefix!

@sujuka99 sujuka99 added type/bug area/documentation Improvements or additions to documentation good first issue Good for newcomers high priority Prioritised issues labels Jan 12, 2024
@sujuka99 sujuka99 added this to the v3.0 milestone Jan 12, 2024
@sujuka99 sujuka99 self-assigned this Jan 16, 2024
sujuka99 added a commit that referenced this issue Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation good first issue Good for newcomers high priority Prioritised issues
Projects
None yet
Development

No branches or pull requests

1 participant