help-librejs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Help-librejs] Make LibreJS friendlier for web developers


From: Tony França
Subject: [Help-librejs] Make LibreJS friendlier for web developers
Date: Sat, 1 Nov 2014 11:26:23 -0200

Recently I updated freedomsponsors.org to be compliant with LibreJS.

From my experience, doing that on a website is not *very* hard, but I'm afraid it's hard enough that people may start, bump on a few obstacles and then give up (because there's a whole lot of other features they have to implement on their website).

On LibreJS home page [1], it says

> The LibreJS project is seeking more _javascript_ programmers to help maintain this browser extension.
> If you want to help, send an email to <address@hidden>.

As far as my (little) experience with it goes, the browser extension is fine. In my opinion it's far more useful to focus efforts into making LibreJS a breeze for web developers, otherwise only very few websites will bother to comply with its standards.

I'd like to give you a few suggestions about how you can do that. The suggestions below are in decrescent order of usefulness.

I strongly believe that implementing those changes will have a considerable impact on LibreJS adoption

1) Live demo examples

This webpage [2] seems to be intended to be the primary source of information for web developers who want their websites to comply with LibreJS.

The topics under [Step 3: Adding license information] desperately needs live demo examples, that shows what works and what doesn't, and explain why.

I was both pleased and annoyed when I found out that there were live demo examples available, but they were "hidden" in the Appendix C of the documentation [3]. Also it's probably a good idea to have a big link on [2] pointing to [3].

2) Weblabels first

Web labels is probably the easiest/fastest way to do it, and yet [2] only kind of mentions it as "last resort" method, "if bandwidth is an issue".

I think describing how to do weblabels should be the first topic under [Step 3: Adding license information]

3) Document the hidden obstacles

When updating freedomsonsors I bumped into a some unanticipated, nontrivial (pun intented :-)) roadblocks. I documented them here [4]. I think this info should be available on the official documentation. Or better yet, document this as Questions+Answers on StackOverflow and have [2] point to them.
Isn't it a shame that searching for "LibreJS" on StackOverflow return 0 results?

4) Build a online testing tool

It would be awesome to have an online tool that could test any given website against LibreJS standards.
Paste your URL, get the results. Is it possible to build such a thing using NodeJS?

5) Have a proper issue tracker, and encourage people to use it.

This is 2014, no Open Source project should be talking about bugs via email.
And don't get me started on Savannah :-)
That thing is so ugly that it's a pain to look at. I think it *hurts* LibreJS to leave its issues there.
People probably will unconsciously avoid touching those issues because it looks so ugly.
Also, I think it's not a good idea to separate bugs [5] from tasks [6].

A much better place for it would be gitorious [7]. It's issue tracker is much more beautiful, and it also makes sense to let the issues live close to the code.

Actually, I think you should even consider to (7)

6) Have a list of cool compliant websites

It's probably a good idea to have [2] point to some cool compliant websites, like rootstrikers.org (I only found out about this by change, on the mail list), and freedomsponsors.org (hehe ;) ).

This can serve both as inspiration and live demos to other people wanting to free their _javascript_ too.

7) Let Gitorious be the single source of information about LibreJS.

It has a wiki, and an issue tracker, and a git repo. That's almost everything an Open Source project needs in terms of tooling.

Let GNU's website be about GNU, and have it point to LibreJS's resources on LibreJS project pages.
It will be a lot easier to find information about LibreJS if everything is under gitorious.org/librejs/[source|wiki|issues]

---------------------------------------------------
This is it. I hope you find it useful!
Cheers!

Tony Lâmpada - the guy from FreedomSponsors

---------------------------------------------------
[1] http://www.gnu.org/software/librejs/
[2] http://www.gnu.org/software/librejs/free-your-_javascript_.html
[3] http://www.gnu.org/software/librejs/manual/librejs.html
[4] http://dicasdolampada.wordpress.com/2014/10/29/how-to-make-librejs-like-you/
[5] https://savannah.gnu.org/bugs/?group=librejs
[6] https://savannah.gnu.org/task/?group=librejs
[7] https://gitorious.org/librejs/


reply via email to

[Prev in Thread] Current Thread [Next in Thread]