botwiki / botwiki.org Goto Github PK

Currently Twitter imagebots aren't shown off to their best, some more vertical space would help. Shouldn't harm textbots either, another tweet or two might fit in.

Some examples:

https://botwiki.org/bots/twitterbots/DeepForger

https://botwiki.org/bots/twitterbots/MMecharin

https://botwiki.org/bots/twitterbots/dscovr_epic

https://botwiki.org/bots/twitterbots/wayback_exe

https://botwiki.org/bots/twitterbots/thenewharperlee

• https://botwiki.org/tutorials/twitterbots#tutorials, either by language and/or required skill level
• https://botwiki.org/resources/public-datasets, create sub-categories for the main list
• https://botwiki.org/resources/libraries-frameworks, mainly the node.js section, by category, I suppose

• Add a pagination plugin
• Add the #bot tag to all .md bot files

Similar to Active vs Inactive. If the user selects active, add #interactive tag.

This will be an ongoing issue with links to resources/tutorials/articles that should be added to Botwiki.org.

For bots that should be added, check out #22.

Learn how to add a checkbox/checklist on GitHub.

Right now, this repo is a "copy" of the repo on my server, which is the one that actually gets pushed live. I want to switch the webhooks to pull from this repo instead.

For reference: https://developer.github.com/webhooks/

For now, the main focus is to add more content, especially more (Twitter) bots.

The site currently uses a minimally modified default Pico CMS theme and is quite usable. This issue is for discussing design changes that will be implemented after enough content has been added.

Some things I'd like to work on:

• the Search Results page needs to be improved
• when browsing by tag, description should be shown (the missing site nav is a separate issue)

@botwikidotorg is a Twitter bot that retweets @ mentions from whitelisted accounts (accounts that this bot follows).

The main use is to be able to post updates about Botwiki by its maintainers rather than having to switch to the @botwikidotorg account.

Originally I meant to have the bot also retweet tweets containing the #botALLY hashtag, but this has been reverted for the moment.

This issue is opened to further discuss how the bot should be used.

This will be an ongoing issue with links to bots that should be added to Botwiki.org.

For resources/tutorials/articles that should be added, check out #23.

Learn how to add a checkbox/checklist on GitHub.

@hugovk A few notes on the awesome script that you made -- mostly small stuff, let me know if you'd prefer me to take care of this myself.

• add network tags based on bot's network, eg: if it's a Twitter bot, the tags should include twitter and twitterbot (we should also check for duplicate tags before saving them) (and for more inconsistency, network tags should never include space or - , so youtubebot is correct)
  • note on adding both twitter and twitterbot: this is pretty much future-proofing the content, in case we want to tag content that's, for example, about Twitter, but not actually a bot
• remove @ from the image file name (in the actual .md file); also, some notes for the future, for non-Twitter bots:
  • spaces should be replaced with _
  • /u/ and /r/ should be removed
  • this is pretty much the same logic as (around the line) https://github.com/botwiki/botwiki.org/blob/master/themes/botwiki/search_results.html#L45
• twitter-bots in the image path should be twitterbots
• is there a way to apply pngcrush (or similar) on the images?
• new line before and after the image thumbnail

Reproduce by:

• open firefox
• responsive design view
• go to 1280 width
• try clicking on the links on top nav bar

Fix

• fiddle around the css of the #search-form

http://choosealicense.com/

This one is going to be pretty difficult, because some of the content are just descriptions copied from people's Twitter/GitHub pages. Repos usually have a license, so would each page have a different license based on where the content was copied from?

How does this stuff even work??

The mobile menu needs a bit of work. Right now it's CSS-only, but really needs a bit of JavaScript for easier on/off toggling (right now you have to "click away" to make the menu disappear).

EDIT: Actually, this can be done just with checkboxes, something like this.

How about a link in the menu (or somewhere) to take you to a random bot page?

A bit like Wikipedia has https://en.wikipedia.org/wiki/Special:Random

Cannot (on live site or forked local site) get e.g. http://www.botwiki.org/foo to display the contents of content/404.md.

So there is an idea to create separate pages for bot makers. (All? More "notable" ones?)

This would be kind of neat, because I could, for example, look up Darius and a page would come up that lists his projects, links to his interviews, etc.

However -- not everyone might like this (this is related to the recently launched Makerbase website.

I'd like to get some input on this before moving forward. The least we'd do is to add a link to have the "profile page" removed. Or we could just reach out to people before adding them to the site?

Having images when searching or browsing tags is nice (example: https://botwiki.org/tag/opensource+node.js), but there will eventually be too many images to load, especially for mobile users.

We're going to need to:

• either implement paging
• lazy load images
• or just go back to not showing images?

On https://botwiki.org/tag/botmaker.

Probably just a brief description, link to botzine.org.

Do we want to also advertise this elsewhere on the site?

Linking to https://www.botwiki.org/tag/game shows:

Current CoC: https://github.com/botwiki/botmakers.org/blob/master/Code%20of%20Conduct.md

• http://contributor-covenant.org/
• https://github.com/digitalocean/engineering-code-of-conduct

The site doesn't handle large amount of traffic all too well (obviously, since the pages are converted from .md files on the fly). I thought about using something like Varnish, but it would be nice to get a free SSL certificate, so maybe CloudFlare would be better?

• https://github.com/midnightLuke/pico-menu-sort
• https://github.com/bjmiller121/pico-nav-sort

Something like this could be useful: https://github.com/DaveKin/Pico_Sitemap

Would it be possible to add some sort of "Edit me" or "Contribute to docs" on each page?

A bit like this: https://pantheon.io/docs/articles/sites/code/redirect-incoming-requests/ or even just a simple link to edit would be great.

It'll help make it more obvious that things can be edited, and encourage people to contribute.

Right now it looks like it's sorted alphabetically (with A-Z coming before a-z).

The site navigation disappears when browsing by tag.

• https://developer.github.com/libraries/
• https://developer.github.com/v3/pulls/#create-a-pull-request

It would be really great if we could find volunteers that would translate the content into other languages.

Is there perhaps a company offering translation services for free to open source projects? (Maybe not, but I was looking at this.)

Or we can just wait until we have enough funding :-)

Also, a technical note: I would like to keep the translated content in the same folder, so you could easily link to, for example, https://botwiki.org/bots/tumblr-bots/deadspelunkers_de.

This might be useful.

Same as on https://botwiki.org/tag/opensource.

• When browsing #game bots, show "Narrow by network", show links to /tag/game+NETWORKNAME

Necessary for the botwiki/open-source-bots#1 merge:

• Search term1 AND term2 AND etc by default, example.
• Implement an OR operator.
• Keep the search term in the search input.

Nice things to have:

• Fuzzy search: this should give the same results as this. This should also work. (Or at least show Did you mean...?). This should be useful.
• If appropriate, instead of page description show a snippet with the search term(s) highlighted.

Also important:

• Code cleanup (see TODO in relevant files)

<meta property="og:image" and <meta name="twitter:image:src" should be updated to show the bot's screenshot, where appropriate.

Related to that, we also need to make a template out of some of the repeating code.

https://github.com/botwiki/botwiki.org/blob/master/themes/botwiki/includes/tags.html#L50
https://github.com/botwiki/botwiki.org/blob/master/themes/botwiki/includes/search_results.html#L47

One way to significantly improve the search would be adding each tutorial/library/framework as a separate .md file -- this way the description and tags for each resource can be greatly expanded.

Something like sindresorhus/gulp-imagemin. Right now I'm just manually running Trimage.

The Pico tag plugin only allows browsing by one tag at a time, so something like https://www.botwiki.org/tag/twitterbot+opensource doesn't work.

This would be a great feature and would help resolve botwiki/open-source-bots#1.

When someone visits https://botwiki.org/tag/opensource, show link to https://github.com/botwiki/open-source-bots.

Something like:

if TAG === 'opensource':
// Above the results
"For a full list, visit github.com/botwiki/open-source-bots"