requestpolicycontinued/requestpolicycontinued.github.io

The project's website

requestpolicycontinued.github.io's Issues

replace.sed and .html file extensions

I was looking for a shorter form of the sed replace lines in replace.sed:

s/](About)/](About.html)/g
s/](FAQ)/](FAQ.html)/g
…

By the way it doesn't allow links containing a # hash tag. I came up with the following one-liner, which requires sed's --regexp-extended option:

s_\]\(([-a-zA-Z]+)(\#[^)]+)?\)_](\1.html\2)_g

The line looks kinda ugly, but it works. But then I recognized that on Github Pages the files can be accessed without the .html ending at all. Both links work:

• https://requestpolicycontinued.github.io/FAQ
• https://requestpolicycontinued.github.io/FAQ.html

This means we could skip the sed line completely – but IMHO we should keep adding the .html extension. So @nodiscc what do you think about the one-liner? I can create a pull request.

Document all UI features

Related RequestPolicyContinued/requestpolicy#706 (comment) A screenshot with annotations (numbers pointing to the feature description in a list) would be a good way to describe what each UI item does.

All users might not want to follow the whole Quick Start guide, and expect to find a summary of what each item does in the docs. Currently the Request Log entry is documented nowhere, as an example.

main, quickstart: dead 'subscriptions' links

Merging into #10

create a custom html template

needed for #2, #3 and #4

Pages have no <title>

man pandoc

 -T STRING, --title-prefix=STRING
              Specify STRING as a prefix at the beginning of  the  title  that
              appears  in  the HTML header (but not in the title as it appears
              at the beginning of the HTML body).  Implies --standalone.

How to update the wiki

Quoted from
the project's website
RequestPolicyContinued/requestpolicy#445

On 2015-06-23 @nodiscc wrote in this comment

The new website/wiki is live at https://requestpolicycontinued.github.io/
and https://github.com/RequestPolicyContinued/requestpolicy/wiki

snip

Please review, report and fix any problem you may find.

@myrdd said:

wow @nodiscc great! Thank you for your effort!

I agree, it is very good.

I have now read all of the website https://requestpolicycontinued.github.io/
and all of the wiki https://github.com/RequestPolicyContinued/requestpolicy/wiki

At the moment, the 'meaning of the words' are very similar.
The 'looks' are slightly different: the website looks a little better than the wiki
but the wiki is 'quite presentable' (I mean easy to read).

I particularly like the screenshots in the Quickstart

Website: https://requestpolicycontinued.github.io/Quickstart.html
Wiki: https://github.com/RequestPolicyContinued/requestpolicy/wiki/Quickstart

The Quickstart is much better than it was on 2015-06-22.

The links in the wiki are generally working but there are still some broken links in the website.
There are, at the moment, 13 pages in the wiki.

I also see that there are issues for the website/wiki:

https://github.com/RequestPolicyContinued/RequestPolicyContinued.github.io/issues

@nodiscc and @myrdd, I think you know all of the above but I wanted to make sure
all readers understood my current understanding, my 'starting position'.

If I understand correctly, one way to think of the website/wiki is:
'the wiki is a preview of the website'. Changes are made in the wiki and are pushed to the website.

I am now going to ask some questions in the spirit of 'how can we make this even better'.

_1._
Would you like a separate wiki?

Another option would be to have a website (that is carefully updated) and a separate wiki.
The wiki could have more input from the community
but which would NOT be 'pushed to the official website'.

Potential advantages include:

• more contributions from the community (from 'non programers').
• changes in the wiki will not 'damage the website' (see 2 - below) for an example.
• the wiki navigation is already working.
• easy to add screenshots (to an issue) which can then be used in the wiki.

---

_2._
How best to update the wiki.

In theory there are several options:

2.1 Have a discussion issue for 'new pages' or 'big changes'.

2.2 In addition to 2.1 have specific issues
(like we have for Pages need a header with a back button #2 and
main, quickstart: dead 'subscriptions' links #8).

2.3 Do a git checkout as described by @nodiscc here
and in
How to push from wiki to website #12

2.4 Edit the wiki.

I would be happy with your choice.

However, I don't think I would contribute to 2.3 Do a git checkout.

On 2015-06-24 I did think about this.
Rather than 'write a long post' I decided to make a very small change, that was easy to
'see and reverse' using method 2.4. Edit the wiki (but without doing a git checkout).
See: https://github.com/RequestPolicyContinued/requestpolicy/wiki/Security/_history

At the time, and on 2015-06-25, I think this 'worked OK'.
The "... described above" became "... described below" in the wiki and, IIRC, on the website.
The website did look like the wiki with a 'hot link' for "Cross-Site Request Forgery", IIRC.

Today, 2015-06-27, the 'wiki is still OK' see
https://github.com/RequestPolicyContinued/requestpolicy/wiki/Security

but the 'website has markdown' see
https://requestpolicycontinued.github.io/Security.html
See this markdown:
[Cross-Site Request Forgery] .

So, this might be 'just teething trouble'
but I am keen help and very keen to avoid giving you extra work.

I have opened a separate issue (#15) for the specific case of the Security.html
that is now 'messed up'.

I have noticed several areas in the wiki, and some comments in
the project's website
RequestPolicyContinued/requestpolicy#445
where I think it would good to 'make things even better'.

I'll wait for feedback and guidance from @nodiscc and @myrdd
on the 'best way forward'.

Cleanup duplicate information

There is still duplicate information at https://github.com/nodiscc/rp-website/wiki/FAQ#how-to-find-relevant-information-about-a-bug and https://github.com/nodiscc/rp-website/wiki/Contributing#testing-reporting-bugs--requesting-new-features

Details for 0.5 download

Subtitle this button with '1.0 is being actively developed, but due to some compatibility issues some users might not want to upgrade yet'

subtitle this button with old version repackaged for current Firefox

use long command line option variants in build.sh

E.g. for pandoc options:

• -t → --to=
• -c → --css=
• -o → --output=

This helps documenting the script.

How to track whitelists with version control?

Hello, thank you for continuing development of RequestPolicy!

One major difference I have observed is that the new edition stores its whitelists in enormous strings inside prefs.js. Are there alternatives that produce more meaningful diffs for tracking Firefox config with version control software?

If not, could someone add a feature to auto-import [profile]/RequestPolicy/*.wls (or similar) as whitelists, and when saving to prefs.js, to only store those entries that aren't in any of the auto-import whitelists yet?

PS: Sorry if this was the wrong repo for this issue. I'll gladly repost it to the "requestpolicy" repo if that's more appropriate.

Raw markdown showing on Security.html

@nodiscc, I am sorry for the extra work.

Copied from How to update the wiki #14

On 2015-06-24 I did think about this.
Rather than 'write a long post' I decided to make a very small change, that was easy to
'see and reverse' using method 2.4 Edit the wiki (but without doing a git checkout).
See: https://github.com/RequestPolicyContinued/requestpolicy/wiki/Security/_history

At the time, and on 2015-06-25, I think this 'worked OK'.
The "... described above" became "... described below" in the wiki and, IIRC, on the website.
The website did look like the wiki with a 'hot link' for "Cross-Site Request Forgery", IIRC.

Today, 2015-06-27, the 'wiki is still OK' see
https://github.com/RequestPolicyContinued/requestpolicy/wiki/Security

but the 'website has markdown' see
https://requestpolicycontinued.github.io/Security.html
See this markdown:
[Cross-Site Request Forgery] .

So, this might be 'just teething trouble'
but I am keen help and very keen to avoid giving you extra work.

Please can you fix this and advise, in #14, about how to avoid
'edits in the wiki damage the website'.

Restore missing Unit tests section

RequestPolicyContinued/requestpolicy#445 (comment)

There's no favicon

16x16 PNG: https://github.com/RequestPolicyContinued/requestpolicy/blob/v1.0.beta9.3/src/skin/requestpolicy-icon-blocked.png

Pages need a header with a back button

eg. when on https://requestpolicycontinued.github.io/Contributing.html you have to use the browser back button to get back to the home page. The page should offer a link for this basic functionality.

Add a sitemap

How to push from wiki to website

@nodiscc what are the steps needed to push from the wiki to the website? Is it the same repository with multiple "remotes"?

Is the following correct?

$ git remote
wiki
website
$ git pull wiki
$ ./build.sh
$ git push website master:master

Website Navigation

Quoted from #14

I have now read all of the website https://requestpolicycontinued.github.io/
and all of the wiki https://github.com/RequestPolicyContinued/requestpolicy/wiki

At the moment, the 'meaning of the words' are very similar.
The 'looks' are slightly different: the website looks a little better than the wiki
but the wiki is 'quite presentable' (I mean easy to read).

snip

If I understand correctly, one way to think of the website/wiki is:
'the wiki is a preview of the website'. Changes are made in the wiki and are pushed to the website.

@nodiscc said:

The normal workflow for the wiki is

• let users/everyone update the wiki
• at some random interval, review the changes made to the wiki, fix things if needed, rebuild HTML pages from markdown and upload to the website repo.

The main benefit is not having to maintain 2 separate documentation sets.

An important difference, between the website and the wiki, is navigation.

On the wiki there are 13 pages. These can all be reached via the 'links in the frame at the top right' of every page in the wiki.

On the website there are some 'unreachable pages'. There is no link in the pages that 'goes to the unreachable page'.
For example, AFAICT, there is no link to "What-is-prefetching".

I expect the link to be:
https://requestpolicycontinued.github.io/What-is-prefetching.html
The page does exist - good.

While there are less than 20 pages I think the website might not need 'navigation'
but if there was a 'back to Home' link on each page it would be easier to use.

Some wikis have many pages.
For example
https://github.com/gorhill/uBlock/wiki
has 84 pages (at 2015-07-02) and it had a Home page that is like a 'Table of Contents'.

Some pages have "Back to Wiki home" link (at the top),
and there is a "Wiki home" link in the top right of every page.

rename `flag-tiny.png`

flag-tiny.png is in fact 32px big, so not tiny. Let's rename it to flag-32px.png.

If you want, we can also rename flag.png to flag-16px.png.

move images and resources to a subdirectory

e04f213#commitcomment-11856533

Restore old website history

Store it in a legacy branch

add a script to find dead links

I think there are two types of dead links

• 404 errors
• non-existing anchors, e.g. index.html#non-existing-anchor