Gluster users - Dec 2015 - Gluster Documentation Update

HI Lindsay,
>
BTW, I still get a lot of dead links from the search on
readthedocs
>
Can you please share couple of examples?

Because, if the dead links are formed due to recent rearrangement of docs,
it will be vanished soon. . That said, when we moved the documentation to
github based, we kept everything in github and rendered to readthedocs.
However, recently one more revisit happened on this approach and now the
documentation is mainly in 3 places.

*) Developer docuement : Inside gluster source code repo (
https://github.com/gluster/glusterfs/tree/master/*doc/developer-guide*)
*) Features/specs  :  https://github.com/gluster*/glusterfs-specs/*
*) Admin/user based : https://github.com/gluster/*glusterdocs*

If I am searching on a string (for ex: quota) in readthedocs  , below link
may come in the search result
http://gluster.readthedocs.org/en/latest/Features/quota-object-count/?highlight=quota

Above is a deadlink because "Features" directory itself is moved and
its
now part of https://github.com/gluster/*glusterfs-specs*
/blob/master/done/Features/quota-object-count.md

Please let us know if you are facing the deadlink issue for some other
scenarios.





--Humble


On Thu, Dec 10, 2015 at 4:38 AM, Lindsay Mathieson <
lindsay.mathieson at gmail.com> wrote:
>
>
> On 10/12/2015 8:56 AM, Amye Scavarda wrote:
>
>> n the interest of making our documentation usable again, we've gone
>> through MediaWiki (the old community pages and documentation) and found
out
>> what was left behind and what needed to be moved over to our
Github-based
>> wiki pages. We'll be turning those live on Github this week, before
>> December 11th.
>>
>
> Brilliant, thanks.
>
> BTW, I still get a lot of dead links from the search on readthedocs
>
>
>> We'd love to make sure that we're not missing anything, so
we'll leave
>> the MediaWiki up until January 1st, and work to consolidate our
>> documentation on ReadTheDocs moving forward.
>>
>> Let me know if you have questions or want to help QA this!
>>
>
>
> What would QA involve?
>
> --
> Lindsay Mathieson
>
> _______________________________________________
> Gluster-users mailing list
> Gluster-users at gluster.org
> http://www.gluster.org/mailman/listinfo/gluster-users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://www.gluster.org/pipermail/gluster-users/attachments/20151210/8a70452f/attachment.html>

On 10/12/15 13:04, Humble Devassy Chirammal wrote:
> BTW, I still get a lot of dead links from the search on readthedocs
> >
>
> Can you please share couple of examples? 

Starting from: http://gluster.readthedocs.org/en/latest, search on 
"tier". Gives the following:

http://gluster.readthedocs.org/en/latest/Features/tier/?highlight=tier

http://gluster.readthedocs.org/en/latest/Feature%20Planning/GlusterFS%203.7/Data%20Classification/?highlight=tier

http://gluster.readthedocs.org/en/latest/Feature%20Planning/GlusterFS%203.7/Small%20File%20Performance/?highlight=tier

All bad links.

Same for searching on "shard"

On Thu, 2015-12-10 at 08:34 +0530, Humble Devassy Chirammal
wrote:
> Above is a deadlink because "Features" directory itself is moved
and
> its now part of https://github.com/gluster/glusterfs-specs/blob/maste
> r/done/Features/quota-object-count.md
What's the long-term plan for these specs? It's useful to be able to
point people to a URL for a spec where they can read it rendered. Do we
plan on publishing them somehow, or is the GitHub preview for Markdown
enough?

Right now, the specs are organized in done and in_progress directories.
I understand this helps organize, but it makes it very difficult to
have links from other places that don't constantly break.

Before I realized you'd already migrated these to the glusterfs-specs
repository, I was working on moving them to the GitHub wiki on the
glusterfs repository. See this for example:

https://github.com/shaunix/glusterfs/wiki/Fault-Injection

I'd really like to have redirects from the old MediaWiki URLs to the
new specs. Also, the front page of gluster.org still point to the wiki
pages for planning, not the glusterfs-specs pages. We need stable URLs
to point people to.

--
Shaun