Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds not-found page #652

Closed
wants to merge 1 commit into from
Closed

Conversation

leostera
Copy link
Contributor

In order to provide a single, consistent not-found message across all clients, we could leverage a not-found page.

There's mainly two things to discuss here:

  • the content of such page
  • the location

If it was part of the index it'd be very easy to implement since the fallback command would be the not found one. Semantically would be a bit wrong perhaps? But it should fit right in with the current pipeline that packages the rest of the pages.

@leostera leostera self-assigned this Jan 10, 2016
@leostera leostera force-pushed the page/not-found branch 2 times, most recently from 2d41376 to 8a624be Compare January 10, 2016 16:28
@igorshubovych
Copy link
Collaborator

Did you try to --render this file with existing clients?

@muteness
Copy link

👍

@leostera
Copy link
Contributor Author

@igorshubovych yes, I just did and I found out that it didn't work properly. Filed issue addressing it on the tldr-node repo.

Other than that, any thoughts? @waldyrious @rubenvereecken @felixonmars @rprieto

@felixonmars
Copy link
Collaborator

How about "guidelines" => "Guidelines"?

Other than that, looks nice to me 👍

@waldyrious
Copy link
Member

Maybe we could put the link to the guidelines before the link to add the page? Otherwise it may be overlooked.

@rubenvereecken
Copy link
Contributor

It doesn't fit with my linter, hence I don't like you.

@leostera
Copy link
Contributor Author

@rubenvereecken it seems to have failed because ruby couldn't be installed? (for some reason)

@rubenvereecken
Copy link
Contributor

Oh don't look at it just yet. And that's really weird.

On a more serious note though, the page would be great. At first I thought you chucked it in with the rest of the pages, or even referred to the not-found command (which has been reported missing on my system before?).

The only annoying bit is that we can't do this anymore:
find pages/* -name ".md" -exec linter {} \;

@leostera
Copy link
Contributor Author

Hm, aren't we doing this instead? https://github.com/tldr-pages/tldr/blob/master/Makefile#L34

@rprieto
Copy link
Contributor

rprieto commented Jan 12, 2016

I like the idea of a nice "not found" message, and do get the value of having some consistency between the clients, for example making sure they all mention the Github URL to add pages. I wonder though if it's important to make everything exactly the same on all clients, and if we need to couple all clients via a single Markdown file.

For example on the web it makes sense to have a nice formatted page with <h1> and <h2> headings, then some text, a few clickable URLs... And on the command line we might want something different like a much shorter message (without all the headings) and obviously we'd need to find a way to render Markdown links. For example how do we render Please take a look at our [Contributing Guidelines](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md); then [Add this page](https://github.com/tldr-pages/tldr/new/master/pages). in a terminal? Maybe something like Please take a look at our Contributing Guidelines (https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md); then Add this page (https://github.com/tldr-pages/tldr/new/master/pages). It feels though that this might need custom Markdown processing that will look good with the current exact not-found.md, but might look weird if we make changes to the page.

Personally I'm in favour of letting each client do its thing. If we keep the number of "official" clients down it should be easy to keep an eye once in a while and submit PRs to suggest "please add the URL for people to add pages", etc.

@waldyrious
Copy link
Member

I'm inclined to agree with @rprieto.

@hidroh
Copy link
Contributor

hidroh commented Jan 13, 2016

Instead of putting this as another command page, maybe adding a pseudo not found page as a reference for all clients and mention it in CONTRIBUTING.md or README.md would be more flexible? After all it's a static informative page, and not meant to be interpreted as another command.

Of course the drawback would be to inform all clients to update their not found page if something changes, says the contributing link.

@leostera
Copy link
Contributor Author

leostera commented Feb 3, 2016

We could still use the base and any client could override it as they see fit (or format it in whichever way it's best for their platform's and communities style of output).

I'd like to get this merged so all clients can fallback to it easily.

@igorshubovych
Copy link
Collaborator

@Ostera, i would rather agree with @rprieto.

I think we can just add this requirement to https://github.com/tldr-pages/tldr/wiki/Minimum-specifications-for-TLDR-command-line-clients

@waldyrious
Copy link
Member

👍 @igorshubovych. Ideally we would be able to have the whole spec for a client in the tldr page for tldr itself (see #744), but it seems some items will have to be specified elsewhere.

@waldyrious waldyrious added the clients Issues pertaining to a particular client or the clients as whole. label Feb 7, 2016
@leostera
Copy link
Contributor Author

leostera commented Feb 8, 2016

Okay then! This seems to not be going to happen, so I might as well close the PR.

@leostera leostera closed this Feb 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Issues pertaining to a particular client or the clients as whole.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants