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

Howto redesign part 1 #451

Open
wants to merge 4 commits into
base: staffdocs-redesign
Choose a base branch
from
Open

Howto redesign part 1 #451

wants to merge 4 commits into from

Conversation

dkess
Copy link
Member

@dkess dkess commented Jan 21, 2019

This is the first phase of re-organizing staffdocs to be nicer to use. There are two big changes in this PR:

  • I've re-organized the folder structure for staffdocs, so there is now a "howto" section with subfolders that represent categories.
  • The howto section is displayed using a masonry layout

It looks like this:
2019-01-20-224841_1316x818_scrot

Note that this PR is not being merged into the master branch-- instead I'm using a branch called staffdocs-redesign. I don't want to productionize this until the URLs stabilize. In a future PR, I plan to merge some pages (like sorry/unsorry) together.

Copy link
Member

@kpengboy kpengboy left a comment

Choose a reason for hiding this comment

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

Nice, this is a very welcome improvement. Thanks for working on it.

Some comments I have on the subdivision of documents:

  • Perhaps it would be better to have a section to group the documents specifically for printing?
  • There's also a blurry line between "Infrastructure" and "Maintenance" e.g. "Installing updates with apt-dater" is under Infrastructure while "lab-wakeup" is under Maintenance.
  • Similarly, the division between User Services and Account Management is sometimes not clear - why are "Alumni account reset" and "approve" under User Services rather than Account Management?

ocfweb/docs/urls.py Outdated Show resolved Hide resolved
@dkess
Copy link
Member Author

dkess commented Apr 5, 2019

Thanks for the feedback. I realize this patch has been sitting here for quite some time. However, this is kind of a good thing since I'm looking at the categories with a fresh set of eyes, and I agree that changes should be made.

Putting printing in its own category seems like a good decision, since it certainly seems tangential to most of our other infrastructure.

Infrastructure and Maintenance also look like they should be merged. I don't think I even remember what the difference was supposed to be for those.

User Services and Account Management have a slightly better line between them: user services are procedures specific to a request a user might make, either over email or in person. Account management is for general tools used when dealing with accounts.

I do plan to merge some articles here. If the number of articles in user services and account management are small enough, I would definitely consider merging those categories as well.

@dkess
Copy link
Member Author

dkess commented Apr 5, 2019

Applied changes, here's what it looks like now:
2019-04-05-002105_1279x785_scrot

@fydai
Copy link
Contributor

fydai commented Jun 1, 2019

Misclick sorry, I closed this and have no idea how to reopen it.

@fydai fydai reopened this Jun 1, 2019
@dkess
Copy link
Member Author

dkess commented Jun 1, 2019

fwiw, I am not sure if this will ever be merged. I would rather us use a static site generator for docs.

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.

3 participants