jQuery: Add article aliases (redirects) -- Example

bfmags commented 7 years ago

Add aliases appending the word "example" to all article titles.

For each article line in the articles.txt file, create aliases and store them in a new redirects.txt file, in the same directory.

Each line of the redirects.txt file should be structured as follows: alias,original line. E.g: ajax example,jQuery.ajax()

The aliases should have:

The word "jQuery" removed
Symbols such as dots replaced with spaces
Parentheses removed
CamelCase words split into different words (eg "createClass" would become "create class")

This change will allow the Instant Answer to trigger for more searches.

Get Started

Join DuckDuckHack Slack to ask questions
Join the DuckDuckHack Forum to discuss project planning and Instant Answer metrics
Read the DuckDuckHack Documentation for technical help

jBaldha commented 7 years ago

bfmags commented 7 years ago

Hi @jBaldha thank you for wanting to contribute, and taking the time writing that code!

Please review our Contributing Guide, also in order to accomplish the task, you'll have to:

Set up your development environment, and fork this repository
Create a Pull request on github referencing this issue #613
Your code will run on a NodeJS environment rather than on the browser
Your files should be placed inside the jQuery Fathead folder (https://github.com/duckduckgo/zeroclickinfo-fathead/tree/master/lib/fathead/jquery)
Your code will parse the articles.txt file and generates a new redirects.txt file

Join DuckDuckHack Slack to ask questions
Join the DuckDuckHack Forum to discuss project planning and Instant Answer metrics
Read the DuckDuckHack Documentation for technical help

Thanks! 😄

Caldwerl commented 7 years ago

I'd like to give this a shot.