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.

Sign up for GitHub

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

Jump to bottom

Dbt Docs, Use user provided index.html #10674

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Dbt Docs, Use user provided index.html #10674

wants to merge 1 commit into from
+12 −2

Conversation

ismailsimsek
Copy link

Resolves dbt-labs/dbt-docs#50

Problem

Currently its not possible to customize index.html file when generating dbt docs. It will be nice feature to be able to change its CSS and HTML content.

Solution

with this change if any of the dbt-docs folders containing index.html then this will be used, instead of dbt provided default file.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@ismailsimsek ismailsimsek requested a review from a team as a code owner September 6, 2024 12:58
@cla-bot cla-bot
Copy link

cla-bot bot commented Sep 6, 2024

Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA.

In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, please reach out through a comment on this PR.

CLA has not been signed by users: @ismailsimsek

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@github-actions github-actions bot added the community This PR is from a community member label Sep 6, 2024
@ismailsimsek ismailsimsek changed the title Dbt Docs generate, use user provided index.html if found Dbt Docs, Use user provided index.html if found Sep 6, 2024
@ismailsimsek ismailsimsek changed the title Dbt Docs, Use user provided index.html if found Dbt Docs, Use user provided index.html Sep 6, 2024
@ismailsimsek
Copy link
Author

@drewbanin @dbeatty10 @jtcohen6 what do you think of this solution? if it looks good i will work on it further..

@hiniko
Copy link

hiniko commented Nov 29, 2024 •
edited
Loading

Any progress on this? I'm also interested in this option for docs! Was about to look into implementing it myself!

@ismailsimsek
Copy link
Author

@hiniko this feature is now implemented by https://github.com/memiiso/opendbt project. feel free to give it a try.

  • just put customized index.html under one of the docs-paths folder
  • run opendbt docs generate it will pick and use your index file instead generic one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
community This PR is from a community member
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

White-labeling dbt docs
2 participants
@ismailsimsek @hiniko