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

[CT-1780] [Regression] Documentation formatting #6559

Closed
2 tasks done
OnFormLimited opened this issue Jan 10, 2023 · 6 comments
Closed
2 tasks done

[CT-1780] [Regression] Documentation formatting #6559

OnFormLimited opened this issue Jan 10, 2023 · 6 comments
Labels
bug Something isn't working dbt-docs [dbt feature] documentation site, powered by metadata artifacts stale Issues that have gone stale

Comments

@OnFormLimited
Copy link

Is this a regression in a recent version of dbt-core?

  • I believe this is a regression in dbt-core functionality
  • I have searched the existing issues, and I could not find an existing issue for this regression

Current Behavior

I noticed that in updating DBT from 0.x to 1.x documentation markup seems to no longer support certain elements for colour (i.e. span style="color:darkslateblue"> Overview )

Expected/Previous Behavior

Code such as span style="color:darkslateblue"> Overview expected to render the text element in the specified colour

Steps To Reproduce

  1. In Develop - click View Docs
  2. Opening page will show elements like Data Warehouse Documentation - instead of the actual text in the specified colour

Relevant log output

No response

Environment

DBT Cloud

- OS: Windows 10
- dbt (working version): 1.2
- dbt (regression version): 0.nnn

Which database adapter are you using with dbt?

No response

Additional Context

No response

@OnFormLimited OnFormLimited added bug Something isn't working regression triage labels Jan 10, 2023
@github-actions github-actions bot changed the title [Regression] <title> [CT-1780] [Regression] <title> Jan 10, 2023
@OnFormLimited OnFormLimited changed the title [CT-1780] [Regression] <title> [CT-1780] [Regression] Documentation formatting Jan 10, 2023
@dbeatty10
Copy link
Contributor

Thanks for reaching out @OnFormLimited !

It sounds like you are using dbt Cloud? If so, the best way to reach out to us is by using the speech bubble (💬) in the dbt Cloud interface or at support@getdbt.com

@dbeatty10 dbeatty10 added awaiting_response dbt-docs [dbt feature] documentation site, powered by metadata artifacts and removed triage labels Jan 10, 2023
@OnFormLimited
Copy link
Author

Thanks lots, will do

@jtcohen6
Copy link
Contributor

This is related to some security changes we made a while ago, in v1.0.x, which sanitize Markdown (and thereby disallow a lot of arbitrary HTML/JS): dbt-labs/dbt-docs#227

Thanks for reaching out to dbt Cloud so they can take a deeper look!

@github-actions
Copy link
Contributor

This issue has been marked as Stale because it has been open for 180 days with no activity. If you would like the issue to remain open, please comment on the issue or else it will be closed in 7 days.

@github-actions github-actions bot added the stale Issues that have gone stale label Jul 10, 2023
@github-actions
Copy link
Contributor

Although we are closing this issue as stale, it's not gone forever. Issues can be reopened if there is renewed community interest. Just add a comment to notify the maintainers.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 17, 2023
@fernandobrito
Copy link

fernandobrito commented Nov 13, 2023

Fun story: we have an internal automation that appends extra "data quality" metrics at the bottom of each model description, formatted as Markdown + HTML tags to color some of the numbers. Every time we upgrade dbt we do a "search and replace" from sanitize:!0 to sanitize:0 in our index.html so we can render our pretty formatting correctly.

image

Ok, technically we have a pre-generated index_customized.html in another folder and we overwrite the index.html with it during our publishing pipeline (we self-host our docs). On every upgrade, we take a newly generated index.html, copy to index_customized.html, and make our changes again.

I understand and agree that it makes sense to sanitize it, so I'm not re-opening the ticket or expecting any action on it. I'm just sharing it here in case other people also want to take the risk and disable the sanitization themselves. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dbt-docs [dbt feature] documentation site, powered by metadata artifacts stale Issues that have gone stale
Projects
None yet
Development

No branches or pull requests

4 participants