Bug #17245

install/crunch2-slurm/install-slurm.html missing from ToC

Added by Michael Crusoe 9 months ago. Updated 5 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
01/29/2021
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-
Release relationship:
Auto

Description

This document seems important, but does not appear to be linked to from any other doc or the sidebar table of contents.

Perhaps there are other orphaned docs as well..


Subtasks

Task #17278: Review 17245-slurm-install-docsResolvedWard Vandewege

Associated revisions

Revision 331ebba8
Added by Ward Vandewege 9 months ago

Merge branch '17245-slurm-install-docs'

closes #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

Revision 020482b3 (diff)
Added by Ward Vandewege 9 months ago

Fix broken documentation links.

refs #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

Revision 64f732db (diff)
Added by Ward Vandewege 9 months ago

Documentation: add a default base_url to the Rakefile to simplify
running linkchecker.

refs #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

Revision 7d8375df (diff)
Added by Ward Vandewege 8 months ago

Documentation: add a default base_url to the Rakefile to simplify
running linkchecker.

refs #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

Revision 5eacdd4d (diff)
Added by Ward Vandewege 7 months ago

Add a comment at the top of the documentation Rakefile about generating
the docs locally.

refs #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

History

#1 Updated by Lucas Di Pentima 9 months ago

  • Target version set to 2021-01-20 Sprint
  • Assigned To set to Lucas Di Pentima
  • Status changed from New to In Progress

#2 Updated by Lucas Di Pentima 9 months ago

Update at 34016a755 - Branch 17245-unreferenced-doc-fix

  • Re-adds the Slurm setup page on the install section of the documentation site.

#3 Updated by Peter Amstutz 9 months ago

I actually think that was dropped on purpose because we didn't want to be in the business of telling people how to set up their SLURM any more.

#4 Updated by Michael Crusoe 9 months ago

Peter Amstutz wrote:

I actually think that was dropped on purpose because we didn't want to be in the business of telling people how to set up their SLURM any more.

We at https://gitter.im/arvados/SURFsara_arv found it useful. Perhaps distill it down to the essentials (the following options may be helpful to set in your slurm config...)

#5 Updated by Lucas Di Pentima 9 months ago

Other non-referenced pages:

$ for f in `find . -name '*.textile.liquid' | cut -c3-`; do grep -q $f _config.yml ; if [ "$?" -eq "1" ]; then echo "$f"; fi; done
install/cheat_sheet.html.textile.liquid
install/install-manual-overview.html.textile.liquid
install/client.html.textile.liquid
install/crunch2-slurm/install-prerequisites.html.textile.liquid
install/pre-built-docker.html.textile.liquid
admin/activation.html.textile.liquid
admin/troubleshooting.html.textile.liquid
user/composer/composer.html.textile.liquid
user/tutorials/intro-crunch.html.textile.liquid

#6 Updated by Lucas Di Pentima 9 months ago

  • Target version changed from 2021-01-20 Sprint to 2021-02-03 Sprint

#7 Updated by Peter Amstutz 9 months ago

  • Assigned To changed from Lucas Di Pentima to Ward Vandewege

#8 Updated by Ward Vandewege 9 months ago

I've made some changes to this page, and re-included it in the index.

Going through the unlinked files:

  • install/cheat_sheet.html.textile.liquid
    admin/activation.html.textile.liquid
    admin/troubleshooting.html.textile.liquid

These appear to be a symlinks that were deliberately installed as part of story 15577. It seems of dubious utility to install symlinks this way, where we keep pretending that the URL exists. We version our documentation per release, and if there are pages that we really care about redirects for, we should be adding these to our webserver config with a 301 (permanent) redirect to the proper URL. I'm removing these 3 symlinks.

  • install/install-manual-overview.html.textile.liquid

This page has been an automatic redirect to install/install-manual-prerequisites.html since 2014, so I'm removing it. This page used a smarter trick that the three pages from above, it had:

<script>
window.location = "install-manual-prerequisites.html";
</script>

in the body to do the redirect.

  • install/client.html.textile.liquid

This page, too, was a leftover from 2014 (content moved at that time). I've removed it.

  • install/crunch2-slurm/install-prerequisites.html.textile.liquid

This was an empty page, I removed it.

  • install/pre-built-docker.html.textile.liquid

Wow, blast from the past, this page documents the old `arvdock` tool, which was removed a long time ago. I've removed the page.

  • user/composer/composer.html.textile.liquid

Ah, some documentation for Composer. I've removed it, I think we've decided to drop Composer.

  • user/tutorials/intro-crunch.html.textile.liquid

An unused overview page that hasn't seen material changes since 2014, I've dropped it.

Ready for review at c81ce0ff89ad019d982bdccb376a823894eea733 on branch 17245-slurm-install-docs

#9 Updated by Lucas Di Pentima 9 months ago

This LGTM, thanks!

#10 Updated by Ward Vandewege 9 months ago

  • % Done changed from 0 to 100
  • Status changed from In Progress to Resolved

#11 Updated by Peter Amstutz 5 months ago

  • Release set to 38

Also available in: Atom PDF