cockpit-project.github.io icon indicating copy to clipboard operation
cockpit-project.github.io copied to clipboard

link to GitHub Discussions forum

Open garrett opened this issue 4 years ago β€’ 10 comments

We do not currently link to our GitHub Discussions forum @ https://github.com/cockpit-project/cockpit/discussions on the website.

It should be linked from the footer, from https://cockpit-project.org/external/wiki/Contributing.html, and perhaps elsewhere. (Front page for higher visibility?)

garrett avatar Nov 16 '21 09:11 garrett

Hi @garrett I would like to work on this issue. I went through the contributing webpage and I think the link should be under Getting Started for better visibility.

Mash707 avatar Sep 13 '23 13:09 Mash707

You don't need to ask to work on something; you can send up a PR.

It doesn't hurt to have it in more places. FWIW: The Getting Started link is the exact same place I suggested. :wink: (In addition to the footer.)

Looking forward to the PR. Thanks!

garrett avatar Sep 20 '23 07:09 garrett

You don't need to ask to work on something; you can send up a PR.

It doesn't hurt to have it in more places. FWIW: The Getting Started link is the exact same place I suggested. :wink: (In addition to the footer.)

Looking forward to the PR. Thanks!

Thanks for the response . I'll start working on a PR.

Mash707 avatar Sep 20 '23 13:09 Mash707

Hi @garrett I am trying to setup the website locally using podman. So far I am able to create the container using _scripts/container-create but I am not able to run the jekyll server locally using _scripts/container-jekyll . I am using windows 11 and git bash as the CLI . image image

Mash707 avatar Sep 21 '23 10:09 Mash707

I'm not sure how it would work on Windows. As far as I'm aware, nobody has actually tried this in Windows. Are you in WSL2?

Your screenshot shows that the Jekyll server is actually running and is available on http://0.0.0.0:4000/ β€” Have you tried visiting that URL in your browser? What happens when you do? It should show you the site.

garrett avatar Sep 21 '23 14:09 garrett

I'm not sure how it would work on Windows. As far as I'm aware, nobody has actually tried this in Windows. Are you in WSL2?

Your screenshot shows that the Jekyll server is actually running and is available on http://0.0.0.0:4000/ β€” Have you tried visiting that URL in your browser? What happens when you do? It should show you the site.

I tried using WSL2 but was not able to proceed further. So I installed podman desktop , through this I was able to create a container and then using git bash I ran the container. I also tried visiting the site but it could not be reached. image What OS do you suggest to try setup the website? I will try creating a virtual machine for the same.

Mash707 avatar Sep 21 '23 17:09 Mash707

What OS do you suggest to try setup the website?

Any standard Linux distribution should work. Fedora would be the best supported; most of us on the team use it.

I tried using WSL2 but was not able to proceed further.

Did you hit any specific problem? (I have no clue about how Windows works with WSL2. I just know that people have run Cockpit within WSL2, so it should also be good enough for running Jekyll, which should be simpler to run.)

So I installed podman desktop , through this I was able to create a container and then using git bash I ran the container.

Which container? How did you create it? :thinking:

The website isn't a container; it uses scripts on Linux to create a container locally, set up dependencies, and loops in a local path for gems.

  1. It creates a container based on the GitHub Pages container that then sets a bundle config path with a Containerfile that's embedded within the script @ https://github.com/cockpit-project/cockpit-project.github.io/blob/main/_scripts/container-create
  2. It then runs commands link updating the gems. https://github.com/cockpit-project/cockpit-project.github.io/blob/main/_scripts/container-update-gems
  3. And when done, it recommends to run a script that runs Jekyll within podman @ https://github.com/cockpit-project/cockpit-project.github.io/blob/main/_scripts/container-jekyll

You could probably replicate this on Windows with Podman Desktop by making a Containerfile that's based on the FROM and RUN lines in the container-create script. And then you'd need to manually update the gems. And then you'd need to run the container with the right arguments in the container-jekyll script.


You can also have a preview on your fork on GitHub. Enable GitHub Pages and it should build whatever is in your main branch.

The place to do that for your repo should be at: https://github.com/Mash707/cockpit-project.github.io/settings/pages

After you enable that (and it builds), it should then show up at https://Mash707.github.io/cockpit-project.github.io/

garrett avatar Sep 25 '23 10:09 garrett

Any standard Linux distribution should work. Fedora would be the best supported; most of us on the team use it.

I tried using Ubuntu on a virtual machine and now I am to run the site now locally. I had to make one change regarding container-create file i.e. I added the following line so that I could run bundle install inside the container. image Now I am able to run the site locally and make changes , will raise a PR soon. image

Did you hit any specific problem? (I have no clue about how Windows works with WSL2. I just know that people have run Cockpit within WSL2, so it should also be good enough for running Jekyll, which should be simpler to run.)

while using WSL2 I was getting the following error when trying to run _scripts/container-create : invalid option

Which container? How did you create it? πŸ€”

I just misunderstood the instructions given in the ReadMe document. (I am new to thisπŸ˜…πŸ˜…) I tried everything again in ubuntu and it worked. Thank you so much for your help.

You can also have a preview on your fork on GitHub. Enable GitHub Pages and it should build whatever is in your main branch.

Actually I can't run a preview on Github because I am unable to turn on Github Pages because it is disabled. image But I don't need to use that now because I am able to run it locally.

Mash707 avatar Sep 25 '23 17:09 Mash707

@Mash707 FTR, we all have this weird "Pages on this forked repo is disabled" warning. That doesn't stop at least my account from getting https://martinpitt.github.io/cockpit-project.github.io/ rendered. But of course local Jekyll is nicer for rapid local turnaround. Great to hear that the podman workflow works for you. Thank you!

martinpitt avatar Sep 26 '23 04:09 martinpitt

@Mash707 FTR, we all have this weird "Pages on this forked repo is disabled" warning. That doesn't stop at least my account from getting https://martinpitt.github.io/cockpit-project.github.io/ rendered. But of course local Jekyll is nicer for rapid local turnaround. Great to hear that the podman workflow works for you. Thank you!

I thought it wouldn't work, nvm I got to learn new things. I'll look for another issue to work upon. Thanks!

Mash707 avatar Sep 26 '23 04:09 Mash707