Skip to content

Conversation

@dean-krueger
Copy link
Contributor

Previous versions of the README left users (me when I was trying to do this for the first time) high and dry after telling them to run make docker-gh-preview. It was not at all clear that to actually view the changes made to the website it needed to be served and visited at localhost. This version of the README gives users (especially new ones) more detailed instructions on exactly what they need to do after they make changes to the website so that they can check their work.

Closes #397

@dean-krueger dean-krueger requested a review from gonuke January 17, 2025 21:41
@dean-krueger
Copy link
Contributor Author

should be python3 -m http.server <port number>. Oops. I'll change that momentarily.

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

A comment about port-forwarding and when it's necessary.

Also, does it make sense to describe how to serve it from inside a docker container and access it? Or do we assume/instruct people to bind mount everything and then launch the server from outside the docker container?

@dean-krueger
Copy link
Contributor Author

should be python3 -m http.server <port number>. Oops. I'll change that momentarily.

Fixed

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

LGTM - thanks @dean-krueger

@gonuke
Copy link
Member

gonuke commented Jun 11, 2025

Oh - needs a rebase or similar

@dean-krueger dean-krueger force-pushed the readme-build-instructions branch from 2003c4b to 88e3dfd Compare June 11, 2025 00:05
@dean-krueger
Copy link
Contributor Author

I hit the "Update Branch --> Rebase" button here on GitHub and it looks like it did a bunch of stuff automatically for me. Not entirely sure if that was good or not, so I'm going to take another quick look. It might be worth the same from @gonuke before we go and hit any buttons (I'll probably not hit that button again).

@dean-krueger
Copy link
Contributor Author

It looks like this should be fine? I guess worst case scenario it messes up the website and then I spent the weekend fixing it.

@gonuke
Copy link
Member

gonuke commented Jun 11, 2025

Thanks @dean-krueger

@gonuke gonuke merged commit e3ddbc3 into cyclus:source Jun 11, 2025
2 checks passed
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.

cyclus.github.com README is unclear on how to actually serve test versions of the website

2 participants