Page MenuHomePhabricator

Clarifiying Documentation Links
ClosedPublic

Authored by SalmonKiller on Jun 10 2015, 9:47 PM.
Tags
None
Referenced Files
F12860522: D13240.id.diff
Fri, Mar 29, 1:26 PM
F12853133: D13240.id32084.diff
Fri, Mar 29, 8:05 AM
F12838863: D13240.id32085.diff
Thu, Mar 28, 6:46 PM
Unknown Object (File)
Fri, Mar 15, 2:07 PM
Unknown Object (File)
Fri, Mar 15, 2:07 PM
Unknown Object (File)
Fri, Mar 15, 2:07 PM
Unknown Object (File)
Mon, Mar 4, 5:49 PM
Unknown Object (File)
Feb 3 2024, 4:57 AM
Subscribers

Details

Summary

Fixes T8487.

Test Plan

Verify that links are clear at Diviner > Phabricator Contributor Docs > Using the Phabricator OAuth Server.

Diff Detail

Repository
rP Phabricator
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

SalmonKiller retitled this revision from to Clarifiying Documentation Links.
SalmonKiller updated this object.
SalmonKiller edited the test plan for this revision. (Show Details)
SalmonKiller edited edge metadata.

Reformatted Links

Reformatted sample links for clarity.

Let me know if you would like me to clarify anything.

src/docs/contributor/using_oauthserver.diviner
38

I think we need higher-level navigation instructions here. The problem we're trying to solve is two-fold:

(1) We want to make it clear that "# Visit <phabricator.example.com>" is not a valid URL.
(2) We want to make sure that the navigation instruction you're giving users is immune to trivial URL changes that we might make in the future.

To solve (1), we decided to simply make the link not clickable, as you did in the other example URL's in this file. To solve (2), you need give users a high-level understanding of where the destination lives, relative to the install homepage.

Open <your local install URL>/oauthserver/client/create/. Where you will find yourself is on a create page of some application. Your job is to communicate directions to that page in {nav X > Y} format. If you look at the crumbs, in the top left of the page, you'll notice that you are in the "OAuth Server" application. So I would open a separate tab and start navigating to the "Create" page the way a user would, if they were following your instructions. When you open the "OAuth Server" application, you'll notice that directing users to "client" doesn't make sense, because there is no word like that on the page. However, there is something called, "Create Application". When you open that, you should notice that that is the exact URL we've been meaning to reach.

So, really, there are three steps the user would need to follow. "Your Local Install", "OAuth Server", "Create Application". Following these steps is the equivalent of navigating to the example URL, but it eliminates any ambiguity, should the example URL cease to be correct in the future.

44

Is there a reason you left off the trailing slash?

79

Here, too?

SalmonKiller edited edge metadata.

Fixed inaccuracies pointed out by lpriestley

epriestley edited edge metadata.
This revision is now accepted and ready to land.Jun 14 2015, 2:44 AM
This revision was automatically updated to reflect the committed changes.