Please Avoid Unnecessarily Breaking Links to Docs

dakanji · 2015-03-14T04:50:15+00:00

wuha~ , the last sentence is what I want, thank you. 在 2015年3月13日星期五 UTC+8下午4:10:15&#xFF0...

Please Avoid Unnecessarily Breaking Links to Docs

dakanji

Hi Yichun,

Please, please, please do not break links in the documentation for trivial/questionable benefits.

The recent change of "Special PCRE Sequences" to "Special Escaping Sequences" is an example.

Links to this on Stackoverflow etc have just been destroyed for no particular compelling reason.

Or, if edits are done, then the old links should somehow still be maintained.

Cheers!

agentzh

Hi Dayo

On Fri, Mar 13, 2015 at 1:50 PM, Dayo Akanji wrote:
> Please, please, please do not break links in the documentation for
> trivial/questionable benefits.
>

I've tried hard to avoid breaking links :)

> The recent change of "Special PCRE Sequences" to "Special Escaping
> Sequences" is an example.
>

I have a strong desire to change this for long because the previous
section name is too narrow and misleading. Hence the edit :)

> Links to this on Stackoverflow etc have just been destroyed for no
> particular compelling reason.
>

Yeah, sorry about that.

> Or, if edits are done, then the old links should somehow still be
> maintained.
>

I wonder how it is possible because the the docs rely on 3rd-party
rendering tools (like wiki.nginx.org's and github's) to generate the
anchor. Well, suggestions welcome :)

Regards,
-agentzh

dakanji

On Saturday, 14 March 2015 00:23:45 UTC+3, agentzh wrote:

Hi Dayo

On Fri, Mar 13, 2015 at 1:50 PM, Dayo Akanji wrote:
> Please, please, please do not break links in the documentation for
> trivial/questionable benefits.
>

I've tried hard to avoid breaking links :)

> The recent change of "Special PCRE Sequences" to "Special Escaping
> Sequences" is an example.
>

I have a strong desire to change this for long because the previous
section name is too narrow and misleading. Hence the edit :)

> Links to this on Stackoverflow etc have just been destroyed for no
> particular compelling reason.
>

Yeah, sorry about that.

> Or, if edits are done, then the old links should somehow still be
> maintained.
>

I wonder how it is possible because the the docs rely on 3rd-party
rendering tools (like wiki.nginx.org's and github's) to generate the
anchor. Well, suggestions welcome :)

Yeah, difficult.

Perhaps a separate section at the very bottom to handle removed and moved sections.

So there could be a section with a "Special PCRE Sequences" anchor that simply has a link to the new section.

It may also work for the ToDo items perhaps (Not sure if they have their own anchors)

If they do, instead of simply "disappearing" them, a link to the fulfilment docs could be posted.

With such in place, I would have not needed to trawl through Google when I noticed the cookie handling ToDo item had vanished from the docs for instance!

Regards,
-agentzh

agentzh

Hello!

On Fri, Mar 13, 2015 at 2:56 PM, Dayo Akanji wrote:
> Perhaps a separate section at the very bottom to handle removed and moved
> sections.
> So there could be a section with a "Special PCRE Sequences" anchor that
> simply has a link to the new section.
>

Added a new section named "Obsolete Sections":

    https://github.com/openresty/lua-nginx-module#obsolete-sections

Thanks for the advice.

> It may also work for the ToDo items perhaps (Not sure if they have their own
> anchors)

No, TODO items do not have their own anchors.

Regards,
-agentzh