This repository was archived by the owner on Jan 10, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 58
Clearer docs overall (from examples to tone) #322
Open
talsraviv
wants to merge
12
commits into
master
Choose a base branch
from
tal/clearer-communication
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ebb34b8
Similar answer bar for Goodie Displaying just like in the Spice doc
talsraviv ca0565d
Add missing images for many template groups
talsraviv dffb6ce
Add examples up at the case-based guide
talsraviv 77628fe
Updating template examples
talsraviv d58fb6c
Merge branch 'master' into tal/cosmetic-but-useful
talsraviv f2636a8
Outlining images I want to use in DDH intro
talsraviv 070e68c
Image inserted
talsraviv 140cf8b
Spruce up contributing + cheat sheets
talsraviv 5e9ac98
Small wordings
talsraviv 004e4d0
Clean up intro
talsraviv d2c5a52
Set stage for tone in submission docs
talsraviv 9375629
remove duplicate text
moollaza File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,16 @@ | ||
| # How Can I Contribute? | ||
|
|
||
| There are several options for contributing to DuckDuckHack, explained below. If you have any questions at any point, feel free to ask on one of our community channels: | ||
| Contributing to DuckDuckHack - at any level - by nature makes a huge impact. | ||
|
|
||
| ## Reach Out | ||
|
|
||
| If you have any questions at any point, feel free to ask on one of our community channels: | ||
|
|
||
| - [Request invite to our Slack team](mailto:[email protected]?subject=AddMe) | ||
| - [DuckDuckHack mailing list](https://duck.co/redir/?u=https%3A%2F%2Fwww.listbox.com%2Fsubscribe%2F%3Flist_id%3D197814) | ||
| - Do not hesitate to email us directly at [[email protected]](mailto:[email protected]). | ||
|
|
||
| ## New? Make Your First Contribution Today | ||
| ## New? Get Your First Taste Today | ||
|
|
||
| If this is your first time contributing to [DuckDuckHack](http://www.duckduckhack.com), you have two great ways to quickly make your first commit: | ||
|
|
||
|
|
@@ -18,9 +22,9 @@ Cheat sheets are a super-easy way to contribute to the live DuckDuckGo AnswerBar | |
|
|
||
| This short tutorial will lead you through all the parts of building a full-loop Goodie. This is a perfect place to start if you have an idea for an original Instant Answer. | ||
|
|
||
| ## Create a New Instant Answer | ||
| ## Feeling Good? Create a New Instant Answer | ||
|
|
||
| Once you're comfortable with the workflow and how Goodies work, we're excited to have you create your own original Instant Answer: | ||
| Once you're comfortable with the workflow and how Goodies work, we're excited to have you create your own original Instant Answer. | ||
|
|
||
| **1. Choose an idea** | ||
|
|
||
|
|
@@ -62,7 +66,9 @@ Thanks! | |
| PS: DuckDuckGo is awesome! | ||
| ``` | ||
|
|
||
| ## Improve an Existing Instant Answer | ||
| P.S. To see just how simple it is to contribute an Instant Answer, check out David Farrell's PerlTricks post: [Writing Instant Answers is Easy](http://perltricks.com/article/169/2015/4/20/Writing-DuckDuckGo-instant-answers-is-easy). | ||
|
|
||
| ## Share Your Wisdom: Improve an Existing Instant Answer | ||
|
|
||
| Another great way to contribute is to improve an existing, live Instant Answer. It's a great way to get further acquainted with Instant Answers, as well as get implementation ideas. (Many contributors report completing their first fix within two hours of forking the repository!) | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,53 @@ | ||
| # Welcome to DuckDuckHack! | ||
| # Welcome to DuckDuckHack | ||
|
|
||
| We are a community of DuckDuckGo users who help improve the search engine with, "Instant Answers". To get started, please [request an invite to our Slack team](mailto:[email protected]?subject=AddMe). You may join multiple Slack channels to discuss your Instant Answer ideas with others who may have the same interests! | ||
| We are a community of DuckDuckGo users who invent and maintain "Instant Answers". | ||
|
|
||
| - [Request Slack invite](mailto:[email protected]?subject=AddMe) | ||
| *Find out [how to contribute](https://duck.co/duckduckhack/contributing), how to [contact us](https://duck.co/duckduckhack/contributing#reach-out) and get involved.* | ||
|
|
||
| You may also wish to join our DuckDuckHack Dev's email list (low traffic): | ||
| ## What are Instant Answers? | ||
|
|
||
| - [DuckDuckHack developer mailing list](https://www.listbox.com/subscribe/?list_id=197814) | ||
| **Instant Answers present what you were seeking in zero clicks:** | ||
|
|
||
|  | ||
|
|
||
| ## What are Instant Answers? | ||
| Instant Answers go right at the top of DuckDuckGo's search results - above ads and even search results. They have the potential to show up on millions of searches every day. | ||
|
|
||
| Instant Answers help you find what you're looking for in few or zero clicks. They're placed above ads and regular search results, and they're created/maintained by you (the community). Some Instant Answers are built from pure code and others require external sources (API requests), databases, or key-value stores. The possibilities are endless but the point is to provide a perfect result for every search. | ||
| Our mission as a community is to cover every topic with an Instant Answer. We're well on our way: you can browse the [full list of Instant Answers](https://duck.co/ia) and see what's been contributed. | ||
|
|
||
|  | ||
| They can be really complicated and dynamic... | ||
|
|
||
|  | ||
|
|
||
| ...or super simple yet convenient. | ||
|
|
||
|  | ||
|
|
||
| Some are just cool: | ||
|
|
||
|  | ||
|
|
||
| Many are absolutely delightful and unexpected: | ||
|
|
||
| In the above example, [Quixey](http://quixey.com/) was a source that our own DuckDuckHack Community suggested for mobile app search. Now, any time someone searches for apps on DuckDuckGo, we request information directly from Quixey to help answer the search. | ||
|  | ||
|
|
||
| Many are super practical... | ||
|
|
||
|  | ||
|
|
||
| ...in ways we never imagined: | ||
|
|
||
|  | ||
|
|
||
| Some Instant Answers are built from pure code: | ||
|
|
||
|  | ||
|
|
||
| Other Instant Answers channel external sources (API requests), databases, or key-value stores. | ||
|
|
||
|  | ||
|
|
||
| To see just how simple it is to contribute an Instant Answer, check out David Farrell's PerlTricks post: [Writing Instant Answers is Easy](http://perltricks.com/article/169/2015/4/20/Writing-DuckDuckGo-instant-answers-is-easy). | ||
| **The [possibilities are endless](https://duck.co/ideas) but the point is to provide a perfect result for every search.** | ||
|
|
||
| In these docs, we'll show you how to build Instant Answers that can do this and more. Start by reading about [ways to contribute](https://duck.co/duckduckhack/contributing). | ||
| In these docs, we'll show you how to build Instant Answers that can do this and more. Let's get started with [ways to contribute](https://duck.co/duckduckhack/contributing). | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe you need placeholder text for these to work. They're not rendering for me on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@moollaza thanks. It's because the image url is to the master branch