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

Anchor links for individual columns/attributes within model page #186

Closed
cjkaufmann opened this issue Apr 16, 2021 · 11 comments
Closed

Anchor links for individual columns/attributes within model page #186

cjkaufmann opened this issue Apr 16, 2021 · 11 comments
Labels
enhancement New feature or request help_wanted Trickier changes, with a clear starting point, good for previous/experienced contributors Stale

Comments

@cjkaufmann
Copy link

Describe the feature

I would love the ability to link to a specific column of my dbt documentation from other areas of documentation. For example, how you have linked directly to a specific header in your documentation (how you can click the # here and link directly to this 'overview' header.
image
I want this ability in our docs, for example, putting a link to go directly to dsse_reporting_group
image

Describe alternatives you've considered

I've tried using HTML anchor links, but this definitely doesn't work within doc blocks.
image

Additional context

This would be very useful for folks who have documentation on exposures for their dashboards, reports, etc. Since you can link from the docs to the exposures, this would allow you to link directly to the dbt docs from those exposures, as well. So it would become full circle.

Who will this benefit?

Everyone who documents their tables/databases/exposures.

Are you interested in contributing this feature?

I'm not sure I could, but I will do anything I can to help.

@cjkaufmann cjkaufmann added the enhancement New feature or request label Apr 16, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2022

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 remove the stale label or comment on the issue, or it will be closed in 7 days.

@github-actions github-actions bot added the Stale label Apr 6, 2022
@cjkaufmann
Copy link
Author

I don't see how to make this not 'stale', but I'd still like it reviewed if possible!

@jtcohen6 jtcohen6 removed the Stale label Apr 6, 2022
@jtcohen6
Copy link
Contributor

jtcohen6 commented Apr 6, 2022

Hey @cjkaufmann, sorry about that! I just removed the Stale label.

For context, as the Core team grows, we're updating our strategies for maintaining our various open source repos. I know we haven't been as responsive to issues in this repo. We just haven't been able to prioritize much net-new development on dbt-docs, relative to higher-leverage work in dbt-core.

If this is something you or another community member would be interested in working on, I think it might work to add an anchor in the column details, somewhere in this neck of the woods:

<td>
<div>
<span class='text-dark'>{{ get_col_name(column.name) }}</span>
</div>
</td>

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2022

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 remove the stale label or comment on the issue, or it will be closed in 7 days.

@github-actions github-actions bot added the Stale label Oct 4, 2022
@cjkaufmann
Copy link
Author

cjkaufmann commented Oct 4, 2022

/lm remove, Stale

@github-actions github-actions bot removed the Stale label Oct 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2023

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 label Apr 4, 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 Apr 12, 2023
@busprint
Copy link

busprint commented Sep 2, 2023

This would be a great addition to docs, so we can create internal links to other models or macros in the documentation of columns or models.

@github-actions github-actions bot added the triage label Sep 2, 2023
@jtcohen6
Copy link
Contributor

I will reopen this one, and mark as help_wanted for an interested community contributor. This isn't something that we'll be able to prioritize ourselves.

@jtcohen6 jtcohen6 added help_wanted Trickier changes, with a clear starting point, good for previous/experienced contributors and removed triage Stale labels Sep 22, 2023
@jtcohen6 jtcohen6 reopened this Sep 22, 2023
@jtcohen6 jtcohen6 changed the title dbt docs anchor link ability Anchor links for individual columns/attributes within model page Sep 22, 2023
@jtcohen6 jtcohen6 removed the triage label Sep 22, 2023
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 label Sep 17, 2024
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 Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help_wanted Trickier changes, with a clear starting point, good for previous/experienced contributors Stale
Projects
None yet
Development

No branches or pull requests

3 participants