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

Updating existing site detail #34

Merged
merged 7 commits into from
Dec 16, 2021

Conversation

connorjbracy
Copy link
Contributor

Put in a hotfix for an issue that prevented the one sanity check this site has for validating that the website will work properly

@connorjbracy connorjbracy changed the title Hotfix for make linkcheck Updating existing site detail Dec 16, 2021
…site and added a missing publication from the list of prior publictions
@connorjbracy
Copy link
Contributor Author

connorjbracy commented Dec 16, 2021

Put in a hotfix for an issue that prevented the one sanity check this site has for validating that the website will work properly

@sbillinge, please review the comment and hotfix described in this first commit. It's definitely a bit hacky (i.e., probably shouldn't be the state of things going forward) but I'm not sure why things are done the way they are with the Spinx config not matching the project layout so that commit is my fix for now. This has been noted in Issue #35

@connorjbracy
Copy link
Contributor Author

connorjbracy commented Dec 16, 2021

@sbillinge The second commit here contains the writeup for adding to, modifying, and publishing changes to diffpy.org. It's a bit lengthy so review at your own discretion (for time sake), but it does also contain the (couple) steps you'll need to do in order to publish updates to the website (see the "Maintainers (Publishing Changes)" section of the README.md file in the second commit within this PR)

@connorjbracy
Copy link
Contributor Author

@sbillinge, this last pair of commits should be everything needed to update the site in its current incarnation and be prepared for the subsequent update of pdfgetx v2.2.0 tomorrow.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

Thanks @connorjbracy

  1. The first commit (update make so that link testing works) looks fine, and well documented.
  2. commit 2 (changes to the docs) is too difficult to review in a PR. I suggest merging it and having me/others proof read everything then.....
  3. There are 55 updated files in this PR and most seem to be somehow associated with a particular release. Things like static_root/doc/pdfgetx/2.1.1/_sources/files.rst.txt which look to me as if they may not need to to be in the PR. Please can you check/confirm?

@connorjbracy
Copy link
Contributor Author

connorjbracy commented Dec 16, 2021

  1. The first commit (update make so that link testing works) looks fine, and well documented.

Sounds good

  1. commit 2 (changes to the docs) is too difficult to review in a PR. I suggest merging it and having me/others proof read everything then.....

I can do that. Alternatively, the file can be viewed without the edit marks here.

  1. There are 55 updated files in this PR and most seem to be somehow associated with a particular release. Things like static_root/doc/pdfgetx/2.1.1/_sources/files.rst.txt which look to me as if they may not need to to be in the PR. Please can you check/confirm?

That is correct. The files are the documents/supporting contents of the pdfgetx v2.1.1 that Tim made some months ago but never got published on the website. That is, pdfgetx v2.1.1 exists on CTV already, but is not mentioned on the website (this pair of commits fixes this discrepancy).

@sbillinge, let me know if you want me to revert the (3) commits from the PR and move them to a separate PR (I decided to lump all these into one PR as they all bring the website into the state that it currently should be and figured it would eliminate any need for possible merge resolution if they were split into multiple PR's - i.e., less work for you)

@sbillinge sbillinge merged commit 137942e into diffpy:source Dec 16, 2021
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.

2 participants