-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
Adds not-found page #652
Conversation
2d41376
to
8a624be
Compare
Did you try to |
👍 |
@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 |
How about "guidelines" => "Guidelines"? Other than that, looks nice to me 👍 |
8a624be
to
2d82e39
Compare
Maybe we could put the link to the guidelines before the link to add the page? Otherwise it may be overlooked. |
2d82e39
to
fa17fb6
Compare
fa17fb6
to
2f4b95e
Compare
It doesn't fit with my linter, hence I don't like you. |
@rubenvereecken it seems to have failed because ruby couldn't be installed? (for some reason) |
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 The only annoying bit is that we can't do this anymore: |
Hm, aren't we doing this instead? https://github.com/tldr-pages/tldr/blob/master/Makefile#L34 |
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 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. |
I'm inclined to agree with @rprieto. |
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. |
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. |
@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 |
👍 @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. |
Okay then! This seems to not be going to happen, so I might as well close the PR. |
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:
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.