Skip to content
This repository has been archived by the owner on Oct 15, 2022. It is now read-only.

Add ed.json for instant answers on ed(1) #1195

Merged
merged 2 commits into from
Jun 24, 2015
Merged

Conversation

Gumnos
Copy link
Contributor

@Gumnos Gumnos commented Jun 19, 2015

@moollaza
Copy link
Member

@Gumnos thanks a lot for contributing, we really appreciate it!

Can you please fill out the pull request template and edit your initial comment. Once completed, we'll be sure to review your PR and give you some feedback.

Thanks!

@Gumnos
Copy link
Contributor Author

Gumnos commented Jun 19, 2015

Spice Pull Request Template

What does your Instant Answer do?

Provides a cheat-sheet for ed(1)

What problem does your Instant Answer solve (Why is it better than organic links)?

Has ed(1) commands as well as details differentiating GNU ed(1) from BSD ed(1)

What is the data source for your Instant Answer? (Provide a link if possible)

http:https://www.gnu.org/software/ed/manual/ed_manual.html
https://www.freebsd.org/cgi/man.cgi?ed%281%29

Why did you choose this data source?

Two authoritative sources on GNU & BSD ed(1)

Are there any other alternative (better) data sources?

Not that I've found

What are some example queries that trigger this Instant Answer?

"ed cheatsheet" or any of the other cheat-sheet triggers

Which communities will this Instant Answer be especially useful for? (gamers, book lovers, etc)

Unix/Linux/BSD geeks

Is this Instant Answer connected to a DuckDuckHack Instant Answer idea?

Not as far as I know.

Which existing Instant Answers will this one supersede/overlap with?

Augments the "cheat sheets"

Are you having any problems? Do you need our help with anything?

After some experimentation on Codio, it came out how I wanted.

What are the terms of use for the API? Will DuckDuckGo need specific authorization (e.g. an API key)? Are there any costs associated with API usage?

N/A

Where did you hear about DuckDuckHack? (For first time contributors)

Twitter @DuckDuckHack account

What does the Instant Answer look like? (Provide a screenshot for new or updated Instant Answers)

A cheat-sheet.

Checklist

Please place an 'X' where appropriate.

Since it only adds a new cheat-sheet to the existing functionality, the remainder should already have been tested. I did test against the Codio server in Chromium & Firefox on Linux and they came out fine.

[x] Added metadata and attribution information
[] Wrote test file and added to t/ directory
[] Verified that instant answer adheres to design guidelines (https://duck.co/duckduckhack/design_styleguide)
[] Verified that instant answer adheres to code styleguide (https://duck.co/duckduckhack/code_styleguide)
[] Tested cross-browser compatibility

    Please let us know which browsers/devices you've tested on:
    - Windows 8
        [] Google Chrome
        [] Firefox
        [] Opera
        [] IE 10

    - Windows 7
        [] Google Chrome
        [] Firefox
        [] Opera
        [] IE 8
        [] IE 9
        [] IE 10

    - Windows XP
        [] IE 8

    - Mac OSX
        [] Google Chrome
        [] Firefox
        [] Opera
        [] Safari

    - iOS (iPhone)
        [] Safari Mobile
        [] Google Chrome
        [] Opera

    - iOS (iPad)
        [] Safari Mobile
        [] Google Chrome
        [] Opera

    - Android
        [] Firefox
        [] Native Browser
        [] Google Chrome
        [] Opera

Also, I didn't see any contribution/license arrangement/agreement terms, but consider my diff/patch under whatever common permissive license you need/want. BSD, WTFPL, CC0, etc.

@moollaza moollaza self-assigned this Jun 19, 2015
"sections": {
"Invocation": [
{
"key": "[ed\u00a0\\[parameters\\]\u00a0\\[filename\\]]",
Copy link
Member

Choose a reason for hiding this comment

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

Please remove the \u00a0 -- it's expected to wrap. We're working towards making sure it always still looks good, so it's alright for now if it doesn't look perfect :)

@moollaza
Copy link
Member

@Gumnos this is looking good. Just a few more things to address and this one should be good 👍

@Gumnos
Copy link
Contributor Author

Gumnos commented Jun 22, 2015

@moollaza How would you like the resulting changes? As a sequence of git commits atop this pull-request, as one single squashed commit atop this pull-request, or as a fresh branch based off origin/master?

@mintsoft
Copy link
Collaborator

@Gumnos commits atop the PR is usual; however you can squash it if you'd prefer

@Gumnos
Copy link
Contributor Author

Gumnos commented Jun 22, 2015

I've added the commits atop this one. They were two commits, one for each requested change, but squashed for simplicity. I can split them back out if you more atomic changes.

moollaza added a commit that referenced this pull request Jun 24, 2015
Add ed.json for instant answers on ed(1)
@moollaza moollaza merged commit 916f6e9 into duckduckgo:master Jun 24, 2015
@moollaza
Copy link
Member

@Gumnos Thanks again for taking the time to contribute! We really appreciate it. Feel free to stick around and comment/help on other PR's & Issues or even submit more Instant Answers!

@moollaza
Copy link
Member

@Gumnos congrats! It's live: https://duckduckgo.com/?q=ed+cheat+sheet&ia=cheatsheet

Sorry for the late notice, it's been live for a few days I believe :)

Thanks again for taking the time to contribute! We really appreciate it. Feel free to stick around and comment/help on other PR's, tackle open issues or even submit more Instant Answers!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants