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

Create a documentation website for dbt-loom #13

Open
nicholasyager opened this issue Jul 19, 2023 · 4 comments
Open

Create a documentation website for dbt-loom #13

nicholasyager opened this issue Jul 19, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nicholasyager
Copy link
Owner

No description provided.

@nicholasyager nicholasyager added the documentation Improvements or additions to documentation label Jul 19, 2023
@nicholasyager nicholasyager added this to the v0.2.0 milestone Jul 19, 2023
@nicholasyager nicholasyager modified the milestones: v0.2.0, 0.2.1 Aug 29, 2023
@nicholasyager nicholasyager removed this from the v0.2.1 milestone Nov 11, 2023
@nicholasyager nicholasyager modified the milestones: 0.5.1, 0.5.2 Apr 19, 2024
@nicholasyager nicholasyager modified the milestones: 0.5.3, 0.5.4 May 9, 2024
@nicholasyager nicholasyager modified the milestones: 0.5.4, 0.5.5 Jun 1, 2024
@nicholasyager nicholasyager removed this from the 0.5.7 milestone Aug 31, 2024
@luiherch
Copy link

luiherch commented Oct 5, 2024

Hello @nicholasyager, I'd like to contribute in this issue. Do you have any plans or ideas for how you want the documentation site to look? Regarding hosting, have you considered GitHub Pages? It's free for public repositories and integrates well with GitHub repos.

@nicholasyager
Copy link
Owner Author

nicholasyager commented Oct 5, 2024

Hey, @luiherch 👋 Happy to hear that you'd like to take this on.

The extent of my plan has been:

  • Create a docs directory
  • Use something basic like Material for mkdocs for static site generation
  • Host the static site using GitHub Pages
  • Have GitHub actions orchestrate the build and deploy process

Admittedly, this plan is just a repeat of what was done for dbt-meshify, so I'm open to alternative approaches of you have a better idea!

@luiherch
Copy link

luiherch commented Oct 5, 2024

@nicholasyager The plan looks great! I'll start working on it right away.

@luiherch
Copy link

Hi @nicholasyager, I've created the documentation website in #91. Have a look at it and let me know if it looks fine or you want me to change anything, I've tried to be as faithful as possible with dbt-meshify.
Had to change the diagram colors as mkdocs overwrittes mermaid's color palette making the diagram unreadble in dark mode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants