diff --git a/ocfweb/docs/docs/staff/backend/mail/vhost.md b/ocfweb/docs/docs/staff/backend/mail/vhost.md index 097e4333a..21d607a84 100644 --- a/ocfweb/docs/docs/staff/backend/mail/vhost.md +++ b/ocfweb/docs/docs/staff/backend/mail/vhost.md @@ -46,4 +46,4 @@ clients to send as a vhost address. (See `/etc/pam.d/smtp` and ## How do I add mail hosting to a group? -See [[here|doc staff/procedures/vhost#mail]]. +See [[here|doc staff/howto/user-services/vhost#mail]]. diff --git a/ocfweb/docs/docs/staff/backend/printhost.md b/ocfweb/docs/docs/staff/backend/printhost.md index 07b2a8640..3eb2240f6 100644 --- a/ocfweb/docs/docs/staff/backend/printhost.md +++ b/ocfweb/docs/docs/staff/backend/printhost.md @@ -140,7 +140,7 @@ and emails users in the case a job fails. After printing a document from a desktop, lab visitors are notified when pages are subtracted from their quota by a little popup notification. This is done by a short daemon script, [notify script][notify], which starts upon login and -runs the [[paper command|doc staff/scripts/paper]] every minute to see if the +runs the [[paper command|doc staff/howto/printing/paper]] every minute to see if the quota has changed. In the future, it would be nice to have a more robust notification system where @@ -157,9 +157,9 @@ current user. ## See also -- [[Printing maintenance|doc staff/procedures/printing]] +- [[Printing maintenance|doc staff/howto/printing/printing]] - The [ocf\_printhost][ocf_printhost] Puppet class -- The [[paper|doc staff/scripts/paper]] command +- The [[paper|doc staff/howto/printing/paper]] command - [CUPS documentation at Samba][cups-samba] (for Windows users, but has general CUPS info as well) diff --git a/ocfweb/docs/docs/staff/backend/switch.md b/ocfweb/docs/docs/staff/backend/switch.md index 3e035ef7b..a3447299c 100644 --- a/ocfweb/docs/docs/staff/backend/switch.md +++ b/ocfweb/docs/docs/staff/backend/switch.md @@ -83,7 +83,7 @@ Port Channel Port-Channel7: More details can be found on the EOS guide online, in the [Port Channel section][lacp-guide]. -LACP also needs to be configured on the [[host side | doc staff/procedures/setting-up-lacp]]. +LACP also needs to be configured on the [[host side | doc staff/howto/infrastructure/setting-up-lacp]]. [primary-switch]: https://www.arista.com/assets/data/pdf/Datasheets/7050SX-128_64_Datasheet.pdf [secondary-switch]: https://www.arista.com/assets/data/pdf/Datasheets/7048T-A_DataSheet.pdf diff --git a/ocfweb/docs/docs/staff/howto.md b/ocfweb/docs/docs/staff/howto.md new file mode 100644 index 000000000..572f19639 --- /dev/null +++ b/ocfweb/docs/docs/staff/howto.md @@ -0,0 +1,4 @@ +[[!meta title="How To's and Procedures"]] + +This section documents how to carry out various procedues at the OCF. Each +page should have a clear set of steps for how to accomplish something. diff --git a/ocfweb/docs/docs/staff/howto/account-management.md b/ocfweb/docs/docs/staff/howto/account-management.md new file mode 100644 index 000000000..9629ab184 --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/account-management.md @@ -0,0 +1,3 @@ +[[!meta title="Account Management"]] + +Querying and modifying user accounts. diff --git a/ocfweb/docs/docs/staff/procedures/accounts/association.md b/ocfweb/docs/docs/staff/howto/account-management/association.md similarity index 95% rename from ocfweb/docs/docs/staff/procedures/accounts/association.md rename to ocfweb/docs/docs/staff/howto/account-management/association.md index 33b59d3c8..3c8893915 100644 --- a/ocfweb/docs/docs/staff/procedures/accounts/association.md +++ b/ocfweb/docs/docs/staff/howto/account-management/association.md @@ -3,7 +3,7 @@ New individual accounts have a `calnetUid` attribute in [[LDAP|doc staff/backend/ldap]] which is used for [[changing passwords online|change_password]], querying CalNet when running -[[`check`|doc staff/scripts/check]], and producing aggregate counts of +[[`check`|doc staff/howto/account-management/check]], and producing aggregate counts of the number of members by university affiliation. Similarly, group accounts have a `callinkOid` attribute. diff --git a/ocfweb/docs/docs/staff/scripts/check.md b/ocfweb/docs/docs/staff/howto/account-management/check.md similarity index 94% rename from ocfweb/docs/docs/staff/scripts/check.md rename to ocfweb/docs/docs/staff/howto/account-management/check.md index 78b5e2a05..18ad4b64f 100644 --- a/ocfweb/docs/docs/staff/scripts/check.md +++ b/ocfweb/docs/docs/staff/howto/account-management/check.md @@ -16,7 +16,7 @@ may only be accessible to privileged users or root, or depend on the server * Virtual host, apphost, and/or virtual mail configuration if applicable * DNS records for any of the above * Signatory of / signatories for -* [[Notes|doc staff/scripts/note]] about the user in `~staff/User_Info` +* [[Notes|doc staff/howto/account-management/note]] about the user in `~staff/User_Info` * Processes running on the current machine owned by that user * Recent login history on the current machine by that user diff --git a/ocfweb/docs/docs/staff/scripts/checkacct.md b/ocfweb/docs/docs/staff/howto/account-management/checkacct.md similarity index 95% rename from ocfweb/docs/docs/staff/scripts/checkacct.md rename to ocfweb/docs/docs/staff/howto/account-management/checkacct.md index 0b10c0e97..bada09787 100644 --- a/ocfweb/docs/docs/staff/scripts/checkacct.md +++ b/ocfweb/docs/docs/staff/howto/account-management/checkacct.md @@ -6,7 +6,7 @@ If a member does not know their account name, you can use this script to look it up. Before recording an account request for a group with [[approve|doc -staff/scripts/approve]], check to see if the group already has an account. Be +staff/howto/user-services/approve]], check to see if the group already has an account. Be sure to use different forms and abbreviations of the group's name to maximize the chance that a group will be found. diff --git a/ocfweb/docs/docs/staff/scripts/chpass.md b/ocfweb/docs/docs/staff/howto/account-management/chpass.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/chpass.md rename to ocfweb/docs/docs/staff/howto/account-management/chpass.md diff --git a/ocfweb/docs/docs/staff/scripts/note.md b/ocfweb/docs/docs/staff/howto/account-management/note.md similarity index 92% rename from ocfweb/docs/docs/staff/scripts/note.md rename to ocfweb/docs/docs/staff/howto/account-management/note.md index fb6c29e1f..f5ae721a6 100644 --- a/ocfweb/docs/docs/staff/scripts/note.md +++ b/ocfweb/docs/docs/staff/howto/account-management/note.md @@ -16,4 +16,4 @@ reasons where some documentation should be made about an OCF account. `note` will append the note-taking user's username, the day's date, the noted user's username, and the note to `~staff/User_Info`, where it can later be retrieved by -[[`check`|doc staff/scripts/check]]. +[[`check`|doc staff/howto/account-management/check]]. diff --git a/ocfweb/docs/docs/staff/procedures/process-accounting.md b/ocfweb/docs/docs/staff/howto/account-management/process-accounting.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/process-accounting.md rename to ocfweb/docs/docs/staff/howto/account-management/process-accounting.md diff --git a/ocfweb/docs/docs/staff/scripts/signat.md b/ocfweb/docs/docs/staff/howto/account-management/signat.md similarity index 98% rename from ocfweb/docs/docs/staff/scripts/signat.md rename to ocfweb/docs/docs/staff/howto/account-management/signat.md index 27c1a305e..585a9047c 100644 --- a/ocfweb/docs/docs/staff/scripts/signat.md +++ b/ocfweb/docs/docs/staff/howto/account-management/signat.md @@ -6,7 +6,7 @@ The `signat` script is used to look up the signatory status of people and student groups. This allows us to verify that the people who email us or come in to [[staff hours|staff-hours]] are really signatories for their group, and it also gives all the information needed to create group accounts with -[[approve|doc staff/scripts/approve]]. +[[approve|doc staff/howto/user-services/approve]]. ## How it works diff --git a/ocfweb/docs/docs/staff/scripts/sorry.md b/ocfweb/docs/docs/staff/howto/account-management/sorry.md similarity index 95% rename from ocfweb/docs/docs/staff/scripts/sorry.md rename to ocfweb/docs/docs/staff/howto/account-management/sorry.md index 522795234..9ad5e35a6 100644 --- a/ocfweb/docs/docs/staff/scripts/sorry.md +++ b/ocfweb/docs/docs/staff/howto/account-management/sorry.md @@ -31,7 +31,7 @@ After sorrying a user, make sure to run the `note` command to document the reasoning to ~staff/User_Info. This reason will be read to future users running `check` on the sorried user. -[[Unsorrying | doc staff/scripts/unsorry]] a user is also possible. +[[Unsorrying | doc staff/howto/account-management/unsorry]] a user is also possible. If a user is sending too much mail, it may be easier to `nomail` the user instead of sorrying their account. This involves adding the user to diff --git a/ocfweb/docs/docs/staff/scripts/unsorry.md b/ocfweb/docs/docs/staff/howto/account-management/unsorry.md similarity index 81% rename from ocfweb/docs/docs/staff/scripts/unsorry.md rename to ocfweb/docs/docs/staff/howto/account-management/unsorry.md index 6828bd98a..f622fe014 100644 --- a/ocfweb/docs/docs/staff/scripts/unsorry.md +++ b/ocfweb/docs/docs/staff/howto/account-management/unsorry.md @@ -4,8 +4,8 @@ For various reasons, we've had to disable accounts. Some for weak passwords, some for security vulnerabilities, or myriad other reasons. If an account -is [[sorried|doc staff/scripts/sorry]], once you've made sure the original problem -has been resolved (you can check `User_Info` via [[check| doc staff/scripts/check]]) +is [[sorried|doc staff/howto/account-management/sorry]], once you've made sure the original problem +has been resolved (you can check `User_Info` via [[check| doc staff/howto/account-management/check]]) you can `unsorry` their account and let them log in again. `unsorry` will remove the user from the sorry group, re-enable a login shell, @@ -21,4 +21,4 @@ infrastructure. It may also be necessary to run `nscd -i passwd` on **`tsunami`**. -Make sure to document all `sorry`ing and `unsorry`ing using [[note|doc staff/scripts/note]] +Make sure to document all `sorry`ing and `unsorry`ing using [[note|doc staff/howto/account-management/note]] diff --git a/ocfweb/docs/docs/staff/procedures/user-quotas.md b/ocfweb/docs/docs/staff/howto/account-management/user-quotas.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/user-quotas.md rename to ocfweb/docs/docs/staff/howto/account-management/user-quotas.md diff --git a/ocfweb/docs/docs/staff/howto/development.md b/ocfweb/docs/docs/staff/howto/development.md new file mode 100644 index 000000000..82cb37a4e --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/development.md @@ -0,0 +1,3 @@ +[[!meta title="Development"]] + +Contributing to the OCF. diff --git a/ocfweb/docs/docs/staff/procedures/backporting-packages.md b/ocfweb/docs/docs/staff/howto/development/backporting-packages.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/backporting-packages.md rename to ocfweb/docs/docs/staff/howto/development/backporting-packages.md diff --git a/ocfweb/docs/docs/staff/procedures/editing-docs.md b/ocfweb/docs/docs/staff/howto/development/editing-docs.md similarity index 95% rename from ocfweb/docs/docs/staff/procedures/editing-docs.md rename to ocfweb/docs/docs/staff/howto/development/editing-docs.md index bd70a1699..f49142137 100644 --- a/ocfweb/docs/docs/staff/procedures/editing-docs.md +++ b/ocfweb/docs/docs/staff/howto/development/editing-docs.md @@ -38,7 +38,7 @@ commiting on master or making a pull request. For more complicated ones, the repository's readme file has instructions for testing and building the website so you can preview your edits before making -the commit. Also see [[our page on Git|doc staff/backend/git]] for further info +the commit. Also see [[our page on Git|doc staff/howto/development/git]] for further info on working with OCF repos. diff --git a/ocfweb/docs/docs/staff/backend/git.md b/ocfweb/docs/docs/staff/howto/development/git.md similarity index 100% rename from ocfweb/docs/docs/staff/backend/git.md rename to ocfweb/docs/docs/staff/howto/development/git.md diff --git a/ocfweb/docs/docs/staff/howto/infrastructure.md b/ocfweb/docs/docs/staff/howto/infrastructure.md new file mode 100644 index 000000000..5699e5401 --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/infrastructure.md @@ -0,0 +1 @@ +[[!meta title="Infrastructure"]] diff --git a/ocfweb/docs/docs/staff/procedures/installing-updates.md b/ocfweb/docs/docs/staff/howto/infrastructure/installing-updates.md similarity index 95% rename from ocfweb/docs/docs/staff/procedures/installing-updates.md rename to ocfweb/docs/docs/staff/howto/infrastructure/installing-updates.md index 5adb66550..c7e0644b3 100644 --- a/ocfweb/docs/docs/staff/procedures/installing-updates.md +++ b/ocfweb/docs/docs/staff/howto/infrastructure/installing-updates.md @@ -17,7 +17,7 @@ To install updates: 1. Make sure the desktops are not [suspended](https://github.com/ocf/puppet/blob/master/modules/ocf_desktop/files/suspend/ocf-suspend), and that you aren't trying to install updates near a 15-minute boundary when - the desktops auto-suspend. See [[lab-wakeup|doc staff/scripts/lab-wakeup]] to + the desktops auto-suspend. See [[lab-wakeup|doc staff/howto/infrastructure/lab-wakeup]] to wake up the desktops prior to updating. 2. From `supernova`, run: diff --git a/ocfweb/docs/docs/staff/scripts/lab-wakeup.md b/ocfweb/docs/docs/staff/howto/infrastructure/lab-wakeup.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/lab-wakeup.md rename to ocfweb/docs/docs/staff/howto/infrastructure/lab-wakeup.md diff --git a/ocfweb/docs/docs/staff/backend/libvirt.md b/ocfweb/docs/docs/staff/howto/infrastructure/libvirt.md similarity index 97% rename from ocfweb/docs/docs/staff/backend/libvirt.md rename to ocfweb/docs/docs/staff/howto/infrastructure/libvirt.md index 74151838d..e88d7f7d6 100644 --- a/ocfweb/docs/docs/staff/backend/libvirt.md +++ b/ocfweb/docs/docs/staff/howto/infrastructure/libvirt.md @@ -79,7 +79,7 @@ then you would run `vncviewer -via jaws 127.0.0.1:10` (or `localhost:10`). ### How do I create a VM? -See [[Creating new hosts|doc staff/procedures/new-host]]. +See [[Creating new hosts|doc staff/howto/infrastructure/new-host]]. ### How do I delete a VM? @@ -97,7 +97,7 @@ On the hypervisor: ### How do I move a VM from one host to another? -Use the [[migrate-vm|doc staff/scripts/migrate-vm]] script. +Use the [[migrate-vm|doc staff/howto/infrastructure/migrate-vm]] script. ### Oh no, I've got a VM with broken networking. How can I access it? diff --git a/ocfweb/docs/docs/staff/scripts/migrate-vm.md b/ocfweb/docs/docs/staff/howto/infrastructure/migrate-vm.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/migrate-vm.md rename to ocfweb/docs/docs/staff/howto/infrastructure/migrate-vm.md diff --git a/ocfweb/docs/docs/staff/procedures/new-host.md b/ocfweb/docs/docs/staff/howto/infrastructure/new-host.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/new-host.md rename to ocfweb/docs/docs/staff/howto/infrastructure/new-host.md diff --git a/ocfweb/docs/docs/staff/procedures/restarting-services.md b/ocfweb/docs/docs/staff/howto/infrastructure/restarting-services.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/restarting-services.md rename to ocfweb/docs/docs/staff/howto/infrastructure/restarting-services.md diff --git a/ocfweb/docs/docs/staff/procedures/setting-up-lacp.md b/ocfweb/docs/docs/staff/howto/infrastructure/setting-up-lacp.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/setting-up-lacp.md rename to ocfweb/docs/docs/staff/howto/infrastructure/setting-up-lacp.md diff --git a/ocfweb/docs/docs/staff/procedures/setting-up-mdraid.md b/ocfweb/docs/docs/staff/howto/infrastructure/setting-up-mdraid.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/setting-up-mdraid.md rename to ocfweb/docs/docs/staff/howto/infrastructure/setting-up-mdraid.md diff --git a/ocfweb/docs/docs/staff/scripts/ssh-list.md b/ocfweb/docs/docs/staff/howto/infrastructure/ssh-list.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/ssh-list.md rename to ocfweb/docs/docs/staff/howto/infrastructure/ssh-list.md diff --git a/ocfweb/docs/docs/staff/procedures/ssl.md b/ocfweb/docs/docs/staff/howto/infrastructure/ssl.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/ssl.md rename to ocfweb/docs/docs/staff/howto/infrastructure/ssl.md diff --git a/ocfweb/docs/docs/staff/howto/other.md b/ocfweb/docs/docs/staff/howto/other.md new file mode 100644 index 000000000..349e81f4e --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/other.md @@ -0,0 +1 @@ +[[!meta title="Other"]] diff --git a/ocfweb/docs/docs/staff/procedures/dmca.md b/ocfweb/docs/docs/staff/howto/other/dmca.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/dmca.md rename to ocfweb/docs/docs/staff/howto/other/dmca.md diff --git a/ocfweb/docs/docs/staff/scripts/how.md b/ocfweb/docs/docs/staff/howto/other/how.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/how.md rename to ocfweb/docs/docs/staff/howto/other/how.md diff --git a/ocfweb/docs/docs/staff/i3wm.md b/ocfweb/docs/docs/staff/howto/other/i3wm.md similarity index 75% rename from ocfweb/docs/docs/staff/i3wm.md rename to ocfweb/docs/docs/staff/howto/other/i3wm.md index 871ade57f..48959218b 100644 --- a/ocfweb/docs/docs/staff/i3wm.md +++ b/ocfweb/docs/docs/staff/howto/other/i3wm.md @@ -1,6 +1,6 @@ [[!meta title="i3wm"]] `i3wm` or `i3` is is a tiling window manager we use on `tornado`, which is the computer behind the ocf tv. -To learn how to access the ocf tv, see [[ocf-tv|doc staff/scripts/ocf-tv]]. A tiling window manager is +To learn how to access the ocf tv, see [[ocf-tv|doc staff/howto/other/ocf-tv]]. A tiling window manager is a window manager that breaks the screen into different tiles, and places applications into these tiles, which are normally controlled by keyboard shortcuts instead of by dragging and dropping. diff --git a/ocfweb/docs/docs/staff/scripts/ocf-tv.md b/ocfweb/docs/docs/staff/howto/other/ocf-tv.md similarity index 92% rename from ocfweb/docs/docs/staff/scripts/ocf-tv.md rename to ocfweb/docs/docs/staff/howto/other/ocf-tv.md index 2822902f5..feca7cefb 100644 --- a/ocfweb/docs/docs/staff/scripts/ocf-tv.md +++ b/ocfweb/docs/docs/staff/howto/other/ocf-tv.md @@ -9,7 +9,7 @@ start a VNC session to the TV. If you do not specify the host it will use the TV by default. `ocf-tv connect` will open up a VNC window using `xvncviewer` to the host. -The TV uses [[i3wm|doc staff/i3wm]], a tiling window manager, so if you are +The TV uses [[i3wm|doc staff/howto/other/i3wm]], a tiling window manager, so if you are unsure of how to use it read the linked documentation. If you'd like to just change the volume on the host, you can use the diff --git a/ocfweb/docs/docs/staff/scripts/pdf-open.md b/ocfweb/docs/docs/staff/howto/other/pdf-open.md similarity index 92% rename from ocfweb/docs/docs/staff/scripts/pdf-open.md rename to ocfweb/docs/docs/staff/howto/other/pdf-open.md index 909782d44..cd33ceb6f 100644 --- a/ocfweb/docs/docs/staff/scripts/pdf-open.md +++ b/ocfweb/docs/docs/staff/howto/other/pdf-open.md @@ -15,6 +15,6 @@ filename doesn't have any spaces or weird characters in it. After re-rasterizing the file, Evince will open, and you can start a new print job from there. Monitor the job's progress in [printhost.ocf.berkeley.edu](//printhost.ocf.berkeley.edu) to ensure the job -survives. You may [[refund|doc staff/scripts/paper]] printing credits to +survives. You may [[refund|doc staff/howto/printing/paper]] printing credits to the user in case they've gone over their daily capacity and you're feeling generous. diff --git a/ocfweb/docs/docs/staff/howto/printing.md b/ocfweb/docs/docs/staff/howto/printing.md new file mode 100644 index 000000000..4c73239ac --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/printing.md @@ -0,0 +1 @@ +[[!meta title="Printing"]] diff --git a/ocfweb/docs/docs/staff/scripts/economode.md b/ocfweb/docs/docs/staff/howto/printing/economode.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/economode.md rename to ocfweb/docs/docs/staff/howto/printing/economode.md diff --git a/ocfweb/docs/docs/staff/scripts/paper.md b/ocfweb/docs/docs/staff/howto/printing/paper.md similarity index 100% rename from ocfweb/docs/docs/staff/scripts/paper.md rename to ocfweb/docs/docs/staff/howto/printing/paper.md diff --git a/ocfweb/docs/docs/staff/procedures/printing.md b/ocfweb/docs/docs/staff/howto/printing/printing.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/printing.md rename to ocfweb/docs/docs/staff/howto/printing/printing.md diff --git a/ocfweb/docs/docs/staff/howto/staff-admin.md b/ocfweb/docs/docs/staff/howto/staff-admin.md new file mode 100644 index 000000000..3c6bbb74c --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/staff-admin.md @@ -0,0 +1 @@ +[[!meta title="Staff Admin"]] diff --git a/ocfweb/docs/docs/staff/procedures/gapps.md b/ocfweb/docs/docs/staff/howto/staff-admin/gapps.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/gapps.md rename to ocfweb/docs/docs/staff/howto/staff-admin/gapps.md diff --git a/ocfweb/docs/docs/staff/procedures/granting-privileges.md b/ocfweb/docs/docs/staff/howto/staff-admin/granting-privileges.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/granting-privileges.md rename to ocfweb/docs/docs/staff/howto/staff-admin/granting-privileges.md diff --git a/ocfweb/docs/docs/staff/howto/user-services.md b/ocfweb/docs/docs/staff/howto/user-services.md new file mode 100644 index 000000000..8446b5285 --- /dev/null +++ b/ocfweb/docs/docs/staff/howto/user-services.md @@ -0,0 +1,3 @@ +[[!meta title="User Services"]] + +Procedures used when responding to user requests (tickets, staff hours). diff --git a/ocfweb/docs/docs/staff/procedures/accounts/alumni-reset.md b/ocfweb/docs/docs/staff/howto/user-services/alumni-reset.md similarity index 90% rename from ocfweb/docs/docs/staff/procedures/accounts/alumni-reset.md rename to ocfweb/docs/docs/staff/howto/user-services/alumni-reset.md index 4db585467..8cc4000f4 100644 --- a/ocfweb/docs/docs/staff/procedures/accounts/alumni-reset.md +++ b/ocfweb/docs/docs/staff/howto/user-services/alumni-reset.md @@ -20,7 +20,7 @@ actual alumnus to perform the search for you, if you are so inclined but unable to access the page on account of your youth. To perform the association, simply follow the steps outlined in the -[[LDAP Association|doc staff/procedures/accounts/association]] documentation +[[LDAP Association|doc staff/howto/account-management/association]] documentation with regards to adding the `calnetUid` record. However, don't delete it after you're done. @@ -46,8 +46,8 @@ password and you can relay this to the alumni. #### Disabled Account {sorried} -If the account is [[sorried|doc staff/scripts/sorry]], refer to the documentation -for [[unsorry|doc staff/scripts/unsorry]] to re-enable the account. +If the account is [[sorried|doc staff/howto/account-management/sorry]], refer to the documentation +for [[unsorry|doc staff/howto/account-management/unsorry]] to re-enable the account. #### Manual Verification of Alumni Identity {verify} diff --git a/ocfweb/docs/docs/staff/scripts/approve.md b/ocfweb/docs/docs/staff/howto/user-services/approve.md similarity index 97% rename from ocfweb/docs/docs/staff/scripts/approve.md rename to ocfweb/docs/docs/staff/howto/user-services/approve.md index 973775c45..e781389d8 100644 --- a/ocfweb/docs/docs/staff/scripts/approve.md +++ b/ocfweb/docs/docs/staff/howto/user-services/approve.md @@ -25,7 +25,7 @@ direct them to an OCF officer. to see what constitutes acceptable documentation. * If the group is a registered student group, you can look up the requester's - signatory status by name with [[signat|doc staff/scripts/signat]]. + signatory status by name with [[signat|doc staff/howto/account-management/signat]]. ```text $ signat name matthew mcallister diff --git a/ocfweb/docs/docs/staff/procedures/vhost.md b/ocfweb/docs/docs/staff/howto/user-services/vhost.md similarity index 100% rename from ocfweb/docs/docs/staff/procedures/vhost.md rename to ocfweb/docs/docs/staff/howto/user-services/vhost.md diff --git a/ocfweb/docs/docs/staff/policies.md b/ocfweb/docs/docs/staff/policies.md index 114e2fc39..b1a362bac 100644 --- a/ocfweb/docs/docs/staff/policies.md +++ b/ocfweb/docs/docs/staff/policies.md @@ -5,7 +5,7 @@ read and be aware of these policies. * [[Staff policy|doc staff/policies/staff-policy]] * [[Keycard policy|doc staff/policies/keycard]] - * The [[restarting services procedure|doc staff/procedures/restarting-services]] + * The [[restarting services procedure|doc staff/howto/infrastructure/restarting-services]] OCF staff should also familiarize themselves with the [University's IT Policies](https://security.berkeley.edu/policy/policy-catalog). diff --git a/ocfweb/docs/docs/staff/procedures.md b/ocfweb/docs/docs/staff/procedures.md deleted file mode 100644 index ed3aa9d32..000000000 --- a/ocfweb/docs/docs/staff/procedures.md +++ /dev/null @@ -1,5 +0,0 @@ -[[!meta title="Procedures"]] - -Create pages under this directory to document how to perform common procedures. - -## Procedures map diff --git a/ocfweb/docs/docs/staff/procedures/accounts.md b/ocfweb/docs/docs/staff/procedures/accounts.md deleted file mode 100644 index c8d0d3fe6..000000000 --- a/ocfweb/docs/docs/staff/procedures/accounts.md +++ /dev/null @@ -1,5 +0,0 @@ -[[!meta title="Accounts"]] - -Create pages under this directory to document account procedures. - -## Accounts map diff --git a/ocfweb/docs/docs/staff/rebuild.md b/ocfweb/docs/docs/staff/rebuild.md deleted file mode 100644 index a651478b0..000000000 --- a/ocfweb/docs/docs/staff/rebuild.md +++ /dev/null @@ -1,5 +0,0 @@ -[[!meta title="Rebuild"]] - -The Great OCF Rebuild - -## Rebuild map diff --git a/ocfweb/docs/docs/staff/rebuild/rt.md b/ocfweb/docs/docs/staff/rt.md similarity index 100% rename from ocfweb/docs/docs/staff/rebuild/rt.md rename to ocfweb/docs/docs/staff/rt.md diff --git a/ocfweb/docs/docs/staff/scripts.md b/ocfweb/docs/docs/staff/scripts.md deleted file mode 100644 index 750cd6e8d..000000000 --- a/ocfweb/docs/docs/staff/scripts.md +++ /dev/null @@ -1,4 +0,0 @@ -[[!meta title="Scripts"]] - -Create subpages under this category to document scripts/programs that are -commonly used in the OCF. diff --git a/ocfweb/docs/templates/docs/partials/doc-masonry.html b/ocfweb/docs/templates/docs/partials/doc-masonry.html new file mode 100644 index 000000000..f57ed3214 --- /dev/null +++ b/ocfweb/docs/templates/docs/partials/doc-masonry.html @@ -0,0 +1,9 @@ +

{{tree.title}}

+
+{% for child in tree.children %} +
+

{{child.title}}

+ {% include 'docs/partials/doc-tree-node.html' with node=child cur_path=cur_path suppress_root=True only %} +
+{% endfor %} +
diff --git a/ocfweb/docs/templates/docs/staff_index.html b/ocfweb/docs/templates/docs/staff_index.html index 62aad28ed..8b6a6614a 100644 --- a/ocfweb/docs/templates/docs/staff_index.html +++ b/ocfweb/docs/templates/docs/staff_index.html @@ -1,8 +1,9 @@ -{% extends 'docs/doc.html' %} +{% extends 'base.html' %} {% load docs %} -{% block after-content %} - {% doc_tree root='/staff/' suppress_root=True cur_path=doc.name %} +{% block content %} + {% doc_masonry root='/staff/howto/' %} + {% doc_tree root='/staff/' suppress_root=True cur_path='/staff/' exclude='^/staff/howto' %} {% endblock %} {% block sidebar %} diff --git a/ocfweb/docs/templatetags/docs.py b/ocfweb/docs/templatetags/docs.py index bcf56ee85..248579ce6 100644 --- a/ocfweb/docs/templatetags/docs.py +++ b/ocfweb/docs/templatetags/docs.py @@ -85,3 +85,8 @@ def doc_toc(toc, collapsible=False): 'html': html, 'collapsible': collapsible, } + + +@register.inclusion_tag('docs/partials/doc-masonry.html') +def doc_masonry(*args, **kwargs): + return doc_tree(*args, **kwargs) diff --git a/ocfweb/docs/urls.py b/ocfweb/docs/urls.py index 0653eaf8f..57deeb4fa 100644 --- a/ocfweb/docs/urls.py +++ b/ocfweb/docs/urls.py @@ -13,6 +13,7 @@ from ocfweb.docs.views.commands import commands from ocfweb.docs.views.hosting_badges import hosting_badges from ocfweb.docs.views.index import docs_index +from ocfweb.docs.views.index import staffdocs_index from ocfweb.docs.views.lab import lab from ocfweb.docs.views.officers import officers from ocfweb.docs.views.servers import servers @@ -37,6 +38,46 @@ REDIRECTS = { '/docs/constitution': 'docs/operatingrules/constitution', '/docs/bylaws': 'docs/operatingrules/bylaws', + + '/staff/backend/git': 'staff/howto/development/git', + '/staff/rebuild/rt': 'staff/rt', + '/staff/backend/libvirt': 'staff/howto/infrastructure/libvirt', + '/staff/i3wm': 'staff/howto/other/i3wm', + '/staff/procedures': 'staff/howto', + '/staff/scripts': 'staff/howto', + '/staff/procedures/accounts/association': 'staff/howto/account-management/association', + '/staff/scripts/check': 'staff/howto/account-management/check', + '/staff/scripts/checkacct': 'staff/howto/account-management/checkacct', + '/staff/scripts/chpass': 'staff/howto/account-management/chpass', + '/staff/scripts/note': 'staff/howto/account-management/note', + '/staff/procedures/process-accounting': 'staff/howto/account-management/process-accounting', + '/staff/scripts/signat': 'staff/howto/account-management/signat', + '/staff/scripts/sorry': 'staff/howto/account-management/sorry', + '/staff/scripts/unsorry': 'staff/howto/account-management/unsorry', + '/staff/procedures/user-quotas': 'staff/howto/account-management/user-quotas', + '/staff/procedures/backporting-packages': 'staff/howto/development/backporting-packages', + '/staff/procedures/editing-docs': 'staff/howto/development/editing-docs', + '/staff/procedures/installing-updates': 'staff/howto/infrastructure/installing-updates', + '/staff/scripts/migrate-vm': 'staff/howto/infrastructure/migrate-vm', + '/staff/procedures/new-host': 'staff/howto/infrastructure/new-host', + '/staff/procedures/restarting-services': 'staff/howto/infrastructure/restarting-services', + '/staff/procedures/setting-up-lacp': 'staff/howto/infrastructure/setting-up-lacp', + '/staff/procedures/setting-up-mdraid': 'staff/howto/infrastructure/setting-up-mdraid', + '/staff/scripts/ssh-list': 'staff/howto/infrastructure/ssh-list', + '/staff/procedures/ssl': 'staff/howto/infrastructure/ssl', + '/staff/scripts/economode': 'staff/howto/printing/economode', + '/staff/scripts/lab-wakeup': 'staff/howto/infrastructure/lab-wakeup', + '/staff/procedures/printing': 'staff/howto/printing/printing', + '/staff/procedures/dmca': 'staff/howto/other/dmca', + '/staff/scripts/how': 'staff/howto/other/how', + '/staff/scripts/ocf-tv': 'staff/howto/other/ocf-tv', + '/staff/scripts/pdf-open': 'staff/howto/other/pdf-open', + '/staff/procedures/gapps': 'staff/howto/staff-admin/gapps', + '/staff/procedures/granting-privileges': 'staff/howto/staff-admin/granting-privileges', + '/staff/procedures/accounts/alumni-reset': 'staff/howto/user-services/alumni-reset', + '/staff/scripts/approve': 'staff/howto/user-services/approve', + '/staff/scripts/paper': 'staff/howto/printing/paper', + '/staff/procedures/vhost': 'staff/howto/user-services/vhost', } @@ -57,7 +98,7 @@ def send_redirect(request, redir_src): def doc_name(doc_name): # we can't actually deal with escaping into a regex, so we just use a whitelist assert re.match(r'^/[a-zA-Z0-9\-/]+$', doc_name), 'Bad document name: ' + doc_name - return doc_name[1:].replace('-', '\\-') + return doc_name[1:].replace('-', r'\-') doc_names = '|'.join(map(doc_name, DOCS.keys())) @@ -66,6 +107,7 @@ def doc_name(doc_name): urlpatterns = [ url(r'^$', docs_index, name='docs'), + url(r'staff/$', staffdocs_index, name='staffdocs'), # we use a complicated generated regex here so that we have actual # validation of URLs (in other words, if you try to make a link to a diff --git a/ocfweb/docs/views/index.py b/ocfweb/docs/views/index.py index 6a47971b2..84bb65efb 100644 --- a/ocfweb/docs/views/index.py +++ b/ocfweb/docs/views/index.py @@ -9,3 +9,13 @@ def docs_index(request): 'title': 'Documentation', }, ) + + +def staffdocs_index(request): + return render( + request, + 'docs/staff_index.html', + { + 'title': 'Staff Documentation', + }, + ) diff --git a/ocfweb/static/scss/pages/_docs.scss b/ocfweb/static/scss/pages/_docs.scss index 557177f6f..8c55fb0d8 100644 --- a/ocfweb/static/scss/pages/_docs.scss +++ b/ocfweb/static/scss/pages/_docs.scss @@ -112,6 +112,33 @@ display: block; } +.ocf-doc-categories { + column-count: 2; +} + +.ocf-category-box { + width: 100%; + padding: 0.625em; + margin: 0.625em; + display: inline-block; + + h4 { + font-size: 1.3em; + margin: 0 0 0.3em 0.1em; + } + + ul { + margin-left: 1.5em; + padding: 0; + } +} + +@media (min-width: 1200px) { + .ocf-doc-categories { + column-count: 3; + } +} + @media (max-width: 767px) { .ocf-doc-toc { display: block; @@ -120,4 +147,8 @@ .ocf-sidebar .ocf-doc-toc { display: none; } + + .ocf-doc-categories { + column-count: unset; + } }