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

Adding documentation website #200

Merged
merged 56 commits into from
Mar 18, 2023
Merged

Conversation

naskio
Copy link
Member

@naskio naskio commented Mar 9, 2023

  • Adding website at docs/.
  • Updating README.md.
  • Moving logo/ folder and other markdown files into the website.
  • Updating links to point to the new domain consuldot.net.
  • Adding GitHub workflow to auto-deploy the website into Pages (The version being used in the website is extracted automatically from the latest tag).

TODO

In order to deploy the website to GitHub Pages, we need to perform the following tasks:

  • Configure DNS for the new domain consuldot.net.
  • Enable GitHub Pages.
  • Merge this PR.

@jgiannuzzi
Copy link
Member

jgiannuzzi commented Mar 10, 2023

This looks awesome, thank you so much for your contribution @naskio! 🤩

@pavlovic-ivan could you please review the workflow?
@mfkl @marcin-krystianc could you please review the content?
@c-rindi could you please setup the domain? (it needs to be a CNAME to g-research.github.io)

@jgiannuzzi
Copy link
Member

I have enabled GitHub Pages for the repo.

Copy link
Contributor

@marcin-krystianc marcin-krystianc left a comment

Choose a reason for hiding this comment

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

It looks great, thanks!

mfkl
mfkl previously approved these changes Mar 10, 2023
@c-rindi
Copy link
Contributor

c-rindi commented Mar 10, 2023

I have set up the DNS - CNAME record.
Thanks for good work @naskio and the clear instructions @jgiannuzzi. 😄

@jgiannuzzi
Copy link
Member

@c-rindi I missed one instruction 😓 — could you please add a similar CNAME for the www subdomain?

@c-rindi
Copy link
Contributor

c-rindi commented Mar 13, 2023

@jgiannuzzi Sorry for the delay - I think I've added that successfully now.

Copy link
Contributor

@pavlovic-ivan pavlovic-ivan left a comment

Choose a reason for hiding this comment

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

@naskio thank you for the PR. one small change required before i approve. the rest looks good to me!

@naskio naskio dismissed stale reviews from mfkl and marcin-krystianc via 251e194 March 14, 2023 14:48
@naskio naskio requested a review from pavlovic-ivan March 14, 2023 14:49
Copy link
Contributor

@pavlovic-ivan pavlovic-ivan left a comment

Choose a reason for hiding this comment

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

@naskio looks good. thanks 🙏

@jgiannuzzi
Copy link
Member

Thanks @c-rindi, the DNS checks are now successful!

Thank you @marcin-krystianc, @mfkl, and @pavlovic-ivan for your reviews, and most importantly thank you @naskio for this amazing contribution!

@jgiannuzzi jgiannuzzi merged commit 082a234 into G-Research:master Mar 18, 2023
@naskio
Copy link
Member Author

naskio commented Mar 18, 2023

Thanks @jgiannuzzi 🚀
I think we also need to add the website url to the repo settings (repo right sidebar)

  • Adding the link to the repo.

@jgiannuzzi
Copy link
Member

Great point @naskio — done!

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

Successfully merging this pull request may close these issues.

6 participants