Skip to content

DOC-5503 enable TCE overrides #1889

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

Merged
merged 5 commits into from
Jul 29, 2025
Merged

Conversation

andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Jul 29, 2025

DOC-5503

This builds on David's great start, modifying the build to allow local TCE example files. The further changes are:

  • Override the default tab name, link title and URL (new fifth, sixth, and seventh parameters to the clients-example shortcode).
  • Hide the Github link icon when the file is supplied locally.

I've left the /develop/clients/test-local-examples test file in place and also the example local source files in the local_examples folder. These files demonstrate the changes but of course, I'll delete them before merging :-)

Also, with all these parameters to this shortcode now, maybe we should consider switching to named parameters? This would be a separate PR, as it would involve changing all the existing TCEs, but it might be neater and more convenient to use.

@andy-stark-redis andy-stark-redis requested review from dwdougherty, cmilesb and a team July 29, 2025 11:07
@andy-stark-redis andy-stark-redis self-assigned this Jul 29, 2025
Copy link
Contributor

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

@andy-stark-redis: this looks great! I do have a couple of suggestions:

  1. Maybe create per-language buckets under local_examples? Otherwise, it could get ugly very quickly.
  2. Augie created the runnable local_examples.py file, but maybe that won't be needed? If not, I'd suggest integrating the local examples processing into the existing build/components and/or build/examples structure.

No hurry on either of these; both can wait until another time. Also, I have no quarrel if you decide you'd rather not do either.

I like the idea of named parameters. Augie could probably make fast work of it.

@andy-stark-redis
Copy link
Contributor Author

Thanks @dwdougherty ! I'll merge this in its current state and fix the time series examples, etc, then I'll get on with implementing your suggestions.

Copy link
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

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

Agree with @dwdougherty's suggestions and also agree with adding named parameters for all of this, but it otherwise looks great! Thank you for taking a look.

@andy-stark-redis andy-stark-redis merged commit 8d01d00 into main Jul 29, 2025
4 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-5503-enable-tce-overrides branch July 29, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Client library docs do not merge yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants