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

changing file name for Building Documentation #65

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

NooraAz
Copy link
Contributor

@NooraAz NooraAz commented May 2, 2024

It has occurred multiple times that I thought "build documentation" meant a guide for building/creating documentation, versus a documentation for building Rosetta. I think the name is a bit misleading, so I suggest changing it to Building Rosetta. (all references to this file have also been changed).

@roccomoretti
Copy link
Member

Note that the version of Gollum we're currently using doesn't have any support for redirects. Which means that any external links to the page (and any Google search results) would now point to a missing page. -- That's an annoyance for many pages, but I would be more than cautious for this particular page.

Note that the redirect consideration is only for the actual page address (the file name of the page) -- changing how the links display on the page (and the title/contents of the page) won't affect the external links.

@@ -785,7 +785,7 @@ A new Job Distributor, JD3, is ready for use. This is mostly invisible to end u
Although most improvements were in Rosetta3.7, we continue to improve the fraction of unmodified PDBs Rosetta can handle. (Don't worry - we've always been able to handle canonical protein well - but we are doing an ever-improving job with strange stuff like the GFP fluorophore, chemically concatenated ligands, glycans, RNA, etc).

###Cxx11 builds
Rosetta turned on Cxx11 features in its C++. This deprecates the compatibility of a lot of older compilers. See <https://www.rosettacommons.org/docs/latest/build_documentation/Cxx11Support> for more information.
Rosetta turned on Cxx11 features in its C++. This deprecates the compatibility of a lot of older compilers. See <https://www.rosettacommons.org/docs/latest/Building_Rosetta/Cxx11Support> for more information.
Copy link
Member

Choose a reason for hiding this comment

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

build_documentation/ here (and in a number of other locations) is a directory name, but it looks like you didn't rename the directory, just the page name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah. I can change them as well if you generally agree with this suggestion.

Copy link
Member

Choose a reason for hiding this comment

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

It's a reasonable change, but the issue with changing directory names is the same as with changing file names -- we don't have redirects, so external links get broken.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How can we add redirects?

Copy link
Member

Choose a reason for hiding this comment

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

There's a newer version of Gollum which supports redirects. But there's some effort which would be needed to merge the Rosetta-specific modifications we've made with the newer version. It's on my list to look into, but I haven't gotten around to it yet -- I'll see if I can bump up the priority.

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

Successfully merging this pull request may close these issues.

2 participants