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

Added account.md #561

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

Added account.md #561

wants to merge 4 commits into from

Conversation

seanvernon
Copy link

This is part of my Opstaff project, but the idea is to have a simple overview of the services available to users which eschews some of the more technical documentation that most people don't understand. Ideally this doc would be used to build a new page in the account section of the website with a url like "https://www.ocf.berkeley.edu/docs/services/account/account-info" that we could then shortlink on a poster with something like "ocf.io/your-account".

Copy link
Member

@dkess dkess left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! I've left some comments.

I'd include some text on the top clarifying that this is information about individual accounts, and link to another page that does a similar explainer for group accounts.

Also, decide on a consistent voice: either refer to the user in the second person ("you") or "users" but avoid switching between both.

ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fydai fydai left a comment

Choose a reason for hiding this comment

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

Thank you so much for your work on this! This would be a valuable user-friendly document that should be added to the default account creation email. Right now the email links to the default docs page, which is not particularly approachable. With this page, users would be able to get an easy summary of the types of things that can be done in the lab.

ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
@seanvernon
Copy link
Author

Per dkessler's comments, I'm going to write a quick group account version of this, and then I'll link that instead of ocf.io/vhost.

@dkess
Copy link
Member

dkess commented Nov 18, 2019

ocf.io/vhost should still contain the specific steps necessary to set up a vhost, it shouldn't be a "marketing" page. But thank you for working on it!

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.

Thanks for working on this page! It'd be great to publicize this page, and make the rest of our docs more easily comprehensible for that matter. I have left a few comments.

ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
ocfweb/docs/templates/docs/partials/account.md Outdated Show resolved Hide resolved
@seanvernon
Copy link
Author

Ok, just updated the page to reflect @kpengboy's comments. Going to tackle the group accounts page during my Thursday morning shift. There's still one "LINK-GOES-HERE", which should link to whichever URL ends up being the aforementioned group accounts page, perhaps "https://www.ocf.berkeley.edu/docs/services/account/group-account-info".

@seanvernon
Copy link
Author

Added group_account.md. There are now two LINK-GOES-HERE's to remove, once we decide on the proper places for these pages when they're done.

[our web hosting page](https://www.ocf.berkeley.edu/docs/services/web/).

If you are a signatory of a student group and would like to request a website
under the berkeley.edu domain (i.e. ocf.berkeley.edu) you will need to create a
Copy link
Member

Choose a reason for hiding this comment

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

Nit

Suggested change
under the berkeley.edu domain (i.e. ocf.berkeley.edu) you will need to create a
under the berkeley.edu domain (e.g. ocf.berkeley.edu) you will need to create a


## Web Hosting (group.berkeley.edu)

When you create any OCF account, you gain access to web hosting space on our
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps "you by default gain access"?

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.

4 participants