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

Move docs to separate site #254

Merged
merged 3 commits into from
May 7, 2024
Merged

Move docs to separate site #254

merged 3 commits into from
May 7, 2024

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Feb 15, 2024

Fixes #255

Starting to look reasonable and close to be ready for deployment. Content still needs a lot of updates but this PR keeps content changes to the absolute minimum for now.

Look at the docs/docs.md file for tips on how to run locally.

We could also look at simply merging this PR so we can get a site deployment set up and the iterate more. I will have to work with @martint to get the gh pages for the branch configured.

Task:

[✅] Improve logo look
[✅ ] Ensure links render in different color from normal text
[] Set up gh pages
[] Test links

@cla-bot cla-bot bot added the cla-signed label Feb 15, 2024
@mosabua mosabua changed the title Move docs to separate site (WIP) Move docs to separate site Feb 15, 2024
mkdocs.yml Outdated Show resolved Hide resolved
@ebyhr ebyhr marked this pull request as draft February 17, 2024 00:23
@mosabua mosabua mentioned this pull request May 2, 2024
@mosabua mosabua force-pushed the site branch 3 times, most recently from 45e06de to 8160df8 Compare May 4, 2024 01:29
@mosabua mosabua marked this pull request as ready for review May 4, 2024 01:30
@mosabua mosabua changed the title (WIP) Move docs to separate site Move docs to separate site May 4, 2024
@mosabua mosabua force-pushed the site branch 2 times, most recently from 08bf30d to 60b9f79 Compare May 6, 2024 21:58
Copy link
Member

@ebyhr ebyhr left a comment

Choose a reason for hiding this comment

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

Just skimmed.

docs/release-notes.md Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/references.md Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
.github/workflows/docs.yml Outdated Show resolved Hide resolved
@mosabua mosabua force-pushed the site branch 2 times, most recently from feb670b to b97aaf1 Compare May 6, 2024 23:38
Copy link
Contributor

@willmostly willmostly left a comment

Choose a reason for hiding this comment

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

Looking good!

mkdocs.yml Show resolved Hide resolved
@mosabua mosabua merged commit 34ddd86 into trinodb:main May 7, 2024
2 checks passed
@mosabua mosabua deleted the site branch May 7, 2024 16:29
@github-actions github-actions bot added this to the 9 milestone May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Create website for docs instead of raw markdown pages
4 participants