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

Fix link in DEPENDENCIES.rst #595

Merged
merged 13 commits into from
Apr 29, 2024
Merged

Fix link in DEPENDENCIES.rst #595

merged 13 commits into from
Apr 29, 2024

Conversation

bennibbelink
Copy link
Contributor

Closes #594. Needed to add a space between the link text and the brackets. Renders correctly on my local site build.

image

@bennibbelink bennibbelink requested a review from abachma2 April 11, 2024 17:54
Copy link

github-actions bot commented Apr 11, 2024

Build Status Report - 796f798 - 2024-04-29 14:34:54 -0500

Build FROM cyclus_20.04_apt/cyclus:latest
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_20.04_apt/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_20.04_conda/cyclus:latest
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_20.04_conda/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_apt/cyclus:latest
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_apt/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_conda/cyclus:latest
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️
Build FROM cyclus_22.04_conda/cyclus:stable
  • Cycamore: Failure
  • Cymetric: Skipped due to upstream failure ⚠️

Copy link
Member

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Hi @bennibbelink. It looks like this change is mostly so that the website page looks cleaner, correct? I suggested removing the indent so that it renders well on Github.

If this is mostly just for website rendering, we may want to take a look at some of the numbering on that page; the numbering restarts in weird places. Some of it may be from this page, but some may be the .rst file for the website

DEPENDENCIES.rst Outdated Show resolved Hide resolved
@bennibbelink
Copy link
Contributor Author

I am having trouble fixing the numbering. It seems to be finicky since we're injecting sections of DEPENDENCIES.rst into the middle of a numbered list in user/install_binary.rst.

@abachma2
Copy link
Member

I was thinking that part might be tricky. If it's not possible for now, I won't let that block this PR from being merged.

@gonuke
Copy link
Member

gonuke commented Apr 13, 2024

What's the best way to preview how these things end up in the website? I'm guessing it's a lot of temporary local customization???...

@abachma2
Copy link
Member

Personally, I copy the contents of this file into the source/user/CYCAMORE_DEPS.rst file in the website repo, then remove the line in the Makefile that pulls it from this repo. That way it won't overwrite that file when you build via make gh-preview.

That, or you can change the Makefile to point to this fork and repo for this file, but I've found that doesn't always capture the latest updates to the file for some reason.

@bennibbelink
Copy link
Contributor Author

bennibbelink commented Apr 15, 2024

That, or you can change the Makefile to point to this fork and repo for this file, but I've found that doesn't always capture the latest updates to the file for some reason.

Near the top of the Makefile in cyclus/cyclus.github.com there are variables set for CYCAMORE_GIT_FORK and CYCAMORE_GIT_BRANCH. If you set them to bennibbelink and fix-link, respectively, the DEPENDENCIES.rst and INSTALL.rst from this branch will get fetched and built into the local site. This is my typical workflow, I have noticed that there is a slight delay from when you push to GitHub and when those changes will be fetched, similar to @abachma2, but usually its on the order of a minute or two.

@bennibbelink bennibbelink requested a review from abachma2 April 17, 2024 15:06
Copy link
Member

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Hi @bennibbelink. Thanks for making those changes. The numbering is still a little weird, and I made a comment about that.

DEPENDENCIES.rst Outdated
Anaconda_ (or miniconda_ for a more lightweight choice) to prepare it for
Cyclus.

.. website_include_conda_end

2. Once you have Conda installed, installing Cyclus straightforward.
#. Once you have Conda installed, installing Cyclus straightforward.
Copy link
Member

Choose a reason for hiding this comment

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

When this renders on GitHub, this line and l.60 both show up with a 1 for the numbering. This may be because of the .. website_include_conda_end in the middle. If you build the website, does the numbering all look good? If so, then I think that's a bigger priority and should keep it as is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the reminder. I've modified it now to include all the information needed for the website, and should be considered in conjunction with cyclus.github.com PR #364. The numbering is looking good on my local build now.

Copy link
Member

@abachma2 abachma2 left a comment

Choose a reason for hiding this comment

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

Approving this now, but I'll merge after I look at 364 in the website

@gonuke
Copy link
Member

gonuke commented Apr 20, 2024

To test this in conjunction with cyclus/cyclus.github.com#364, do I need to do an ad-hoc change to the Makefile in cyclus/cyclus.github.com#364 so that it loads this updated version?

@bennibbelink
Copy link
Contributor Author

To test this in conjunction with cyclus/cyclus.github.com#364, do I need to do an ad-hoc change to the Makefile in cyclus/cyclus.github.com#364 so that it loads this updated version?

Correct, you need to reference my fork and the fix-link branch.

@gonuke
Copy link
Member

gonuke commented Apr 29, 2024

Let's dive in and see how this comes together on the website

@gonuke gonuke closed this Apr 29, 2024
@gonuke gonuke reopened this Apr 29, 2024
@gonuke gonuke merged commit 89d4652 into cyclus:main Apr 29, 2024
10 of 11 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.

Link not formatted correctly in DEPENDENCIES.rst
3 participants