databricks
Remove most of the relative links throughout the docs and push people to gitbook menus instead
All the links throughout the docs cause two problems:
- Maintainability (see #8)
- Encourage people not to use gitbooks and instead click around the github project
The later is a less than ideal experience for reading the doc - the github project is better served for developers looking to make a contribution.
Let's remove all the relative links from the doc pages and just let the gitbook menu do the work
Hmmm - I see your point, but This means someone who has the repo in their own machine can't link with their own directory. Perhaps they r viewing the documentation but don't have wifi access.
I think it would be better to keep the relative links most of the time, but maybe worth considering to have more of the links hardcover?
Vida On Thursday, October 16, 2014, Pat McDonough [email protected] wrote:
All the links throughout the docs cause two problems:
- Maintainability (see #8 https://github.com/databricks/reference-apps/issues/8)
- Encourage people not to use gitbooks and instead click around the github project
The later is a less than ideal experience for reading the doc - the github project is better served for developers looking to make a contribution.
Let's remove all the relative links from the doc pages and just let the gitbook menu do the work
— Reply to this email directly or view it on GitHub https://github.com/databricks/reference-apps/issues/22.
Anybody using this in their own repo should be using the gitbook tools, so wouldn't think they need links embedded in the docs either.
On Thu, Oct 16, 2014 at 11:23 AM, vidaha [email protected] wrote:
Hmmm - I see your point, but This means someone who has the repo in their own machine can't link with their own directory. Perhaps they r viewing the documentation but don't have wifi access.
I think it would be better to keep the relative links most of the time, but maybe worth considering to have more of the links hardcover?
Vida On Thursday, October 16, 2014, Pat McDonough [email protected] wrote:
All the links throughout the docs cause two problems:
- Maintainability (see #8 https://github.com/databricks/reference-apps/issues/8)
- Encourage people not to use gitbooks and instead click around the github project
The later is a less than ideal experience for reading the doc - the github project is better served for developers looking to make a contribution.
Let's remove all the relative links from the doc pages and just let the gitbook menu do the work
— Reply to this email directly or view it on GitHub https://github.com/databricks/reference-apps/issues/22.
— Reply to this email directly or view it on GitHub https://github.com/databricks/reference-apps/issues/22#issuecomment-59406661 .
Okay!
On Thursday, October 16, 2014, Pat McDonough [email protected] wrote:
Anybody using this in their own repo should be using the gitbook tools, so wouldn't think they need links embedded in the docs either.
On Thu, Oct 16, 2014 at 11:23 AM, vidaha <[email protected] javascript:_e(%7B%7D,'cvml','[email protected]');> wrote:
Hmmm - I see your point, but This means someone who has the repo in their own machine can't link with their own directory. Perhaps they r viewing the documentation but don't have wifi access.
I think it would be better to keep the relative links most of the time, but maybe worth considering to have more of the links hardcover?
Vida On Thursday, October 16, 2014, Pat McDonough <[email protected] javascript:_e(%7B%7D,'cvml','[email protected]');> wrote:
All the links throughout the docs cause two problems:
- Maintainability (see #8 https://github.com/databricks/reference-apps/issues/8)
- Encourage people not to use gitbooks and instead click around the github project
The later is a less than ideal experience for reading the doc - the github project is better served for developers looking to make a contribution.
Let's remove all the relative links from the doc pages and just let the gitbook menu do the work
— Reply to this email directly or view it on GitHub https://github.com/databricks/reference-apps/issues/22.
— Reply to this email directly or view it on GitHub < https://github.com/databricks/reference-apps/issues/22#issuecomment-59406661>
.
— Reply to this email directly or view it on GitHub https://github.com/databricks/reference-apps/issues/22#issuecomment-59409280 .