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

tasks: Update User guides task descrtipion for GCI 2017. #630

Merged
merged 1 commit into from
Nov 22, 2017
Merged

tasks: Update User guides task descrtipion for GCI 2017. #630

merged 1 commit into from
Nov 22, 2017

Conversation

synicalsyntax
Copy link
Member

No description provided.

* If this is your first contribution, you may be interested in the
[how to create a pull request](https://codein.withgoogle.com/tasks/6541581402243072/) task.
* **Completion of the
[submit a pull request](../submit-a-pull-request.md) task**. The task helps
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be ./submit-a-pull-request.md?

your browser on `http://<hostname>:9991/help/<feature>`, where
`<hostname>` is either `localhost` or the hostname of your VM, and
`<feature>` is the name of the feature.
Well-written user documentation help users and search engines discover Zulip
Copy link
Member

Choose a reason for hiding this comment

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

r/help/helps

@timabbott timabbott merged commit c13c5d5 into zulip:master Nov 22, 2017
@timabbott
Copy link
Member

Looks great, merged! I think we might want to resurrect a variant of "task type B" where their job is to go through a group of 5 articles, try to follow the instructions somewhat blindly, taking notes on what didn't work. And then also compare with the UI and see what other articles should possibly be link. And the work product is a list of things about that documentation that can be improved.

I think we could have ~20 tasks that way (by grouping articles; I think we want each to involves carefully reviewing ~3-5 pages of text).

@synicalsyntax also, we should produce a script with a list of articles to write. I'd shy away from the "document app X" articles that didn't happen last year for early tasks, since I think the reason they didn't happen is they're larger/more difficult projects, and we want to start with 20+ user docs tasks that are easy to do.

@timabbott
Copy link
Member

Opened #635 for the new task.

@synicalsyntax synicalsyntax deleted the user-guide-2017 branch November 27, 2017 16:56
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