Typo on https://openshift.io/osiogettingstarted.pdf

[nimishamukherjee]

https://openshift.io/osiogettingstarted.pdf
Page 25 - Change Approvel to Approval

[sbose78]

@qodfathr marking this as Sev2 because it doesn't look good to have typos in docs :)

[qodfathr]

Making a SEV4 because this doc will soon be obsolete... :)

[bartoszmajsak]

@rkratky @joshuawilson how this doc is ultimately generated and where is the repo we could send a PR to? Shall we look in https://github.com/fabric8io/fabric8-online-docs?

[sbose78]

@bartoszmajsak https://github.com/openshiftio/openshift.io/tree/master/src/assets/documents

[rkratky]

@bartoszmajsak This PDF is deprecated (and has been for a long time). The URL should redirect either to https://docs.openshift.io/getting-started-guide.pdf or even better just to https://docs.openshift.io/

@sbose78 Could you make that redirect happen?

[bartoszmajsak]

Thanks, @sbose78 @rkratky, but those links don't really answer my question. In the spirit of open source what I was hoping we can start doing is that if we see such a typo we simply open PR with the correction (ideally that should be caught during the build process of the PDF itself). So let me rephrase my question:

can you point me to the repository and build scripts using which this PDF is generated?

[bartoszmajsak]

On top of that. I don't see this PDF being available in the help section.

Documentation link points to https://docs.openshift.io/

Can we just delete this file?

[rkratky]

@bartoszmajsak What I'm saying is that the PDF (https://openshift.io/osiogettingstarted.pdf) should not be made available at all. It should be either deleted or redirected to the correct docs. There's no point in fixing it. It is not, and will not be, maintained.

Instead, all users should be pointed to the docs at docs.openshift.io -- which is where you'll also find a new, maintained PDF with the Getting Started Guide (https://docs.openshift.io/getting-started-guide.pdf), should you wish to use it.

If you find a mistake in the 'new', maintained docs, please, either submit an issue or a PR at https://github.com/fabric8io/fabric8-online-docs -- and the docs team will do its best to quickly fix it.

[rkratky]

ideally that should be caught during the build process of the PDF itself

At this point, our CI doesn't check for typos, but we do implement a bunch of other checks to make reasonably sure the docs don't go out with mistakes. We'll look into checking for typos.

(Again, this is for the 'new' docs. The old PDF referenced by the OP was created by Todd who manually exported it from MS Word. Fortunately, we're over that :)

[bartoszmajsak]

There's no point in fixing it. It is not, and will not be, maintained.

@rkratky so we are on the same page. We should make redirect perhaps, but I am just wondering if that link is by any means relevant - shared / exposed somehow. If not deleting is enough.

If you find a mistake in the 'new', maintained docs, please, either submit an issue or a PR at

maybe some GitHub ribbon or some other ways to encourage/promote collaboration in the docs could help to get those PRs? WDYT?

[rkratky]

if that link is by any means relevant - shared / exposed somehow

It was promoted quite heavily (in registration e-mails) during the early days of OSIO, so I believe a redirect to docs.openshift.io would be better.

maybe some GitHub ribbon or some other ways to encourage/promote collaboration in the docs could help to get those PRs?

Good idea. I filed fabric8io/fabric8-online-docs#409 to track it.

[bartoszmajsak]

Wasn't aware of that heavy promotion, so yeah, a redirect will do.

Closing in favor of #4162