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

Add a configs reference page, and tidy up other readmes #1688

Merged
merged 1 commit into from
Mar 14, 2024

Conversation

Ekrekr
Copy link
Contributor

@Ekrekr Ekrekr commented Mar 14, 2024

No description provided.

@Ekrekr Ekrekr requested a review from lewish March 14, 2024 13:48
@@ -0,0 +1,8 @@
#!/bin/bash

docker pull pseudomuto/protoc-gen-doc
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously I would prefer that this was part of bazel but I won't block on that!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC We need to update docker rules because they're still using Python 2.7, I'll look into updating this after that is done!

docker run --rm \
-v $(pwd)/docs:/out \
-v $(pwd)/protos:/protos \
pseudomuto/protoc-gen-doc configs.proto --doc_opt=markdown,configs-reference.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's see if we can generate lowerCameCase names

Copy link
Contributor Author

@Ekrekr Ekrekr Mar 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no option for this currently - we would have to add it as a feature ourselves. I may do this!

@Ekrekr Ekrekr merged commit a11cdd8 into main Mar 14, 2024
4 checks passed
@Ekrekr Ekrekr deleted the add-configs-reference branch March 14, 2024 14:31
moker-spaghetti pushed a commit to moker-spaghetti/dataform that referenced this pull request May 26, 2024
…rence

Add a configs reference page, and tidy up other readmes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants