Fixed Bad Links in Getting Started Docs

[mmattioli]

There are several bad links in the getting started docs that returned 404 pages on GitHub. Additionally, the headers weren't properly formatted. Both of these issues were rectified with proper links from the inboxapp website.

[caitp]

LGTM

[caitp]

Actually you know what? These files are being preprocessed to build https://www.inboxapp.com/docs/gettingstarted, and I'm not sure if using proper markdown headings will work correctly

But the URL changes are definitely okay

[mmattioli]

Those files are .mdown files and you can see in the commits how they were styled before. Properly .mdown is to either have

Title
---

or

#Title

and they had neither. I can make another commit and change it back if you want but I don't see why if that's not proper .mdown format.

[caitp]

@mmattioli I can see that they're markdown files, however it's not clear that they're being rendered exactly the same way that markdown is rendered on inboxapp.com, because as you can see, the titles are being rendered as titles there. I'm not sure which tool we're using for that, but it shouldn't be too hard to figure out if I poke through the webserver a bit. However I think it's better to wait for one of the folks in the office to take a look at it and document this somewhere.

I understand that this ("this" being the Title: ... notation) is not markdown proper, but these files are meant to be consumed via the website, and not on github. At least, as far as I can tell at this time, and when consumed from the website, they look "right".

That said, fixing the URLs is probably a good idea.

[mmattioli]

@caitp I gotcha. Apologies if I came off stubborn or arrogant, I just wanted to convey my intentions and reasoning for that commit.

If you want me to make another commit to change something I'd be more than happy to :)

[mmattioli]

@spang, @grinich perhaps one of you can shed some light on this? Apologies if either of you were the wrong ones to reach out to regarding this.

[grinich]

These markdown files are supposed to be read via https://www.inboxapp.com/docs and are only tracked here for convenience and versioning (if the API changes).

Were any of these links actually broken, or are these just http/https and apex domain/not changes?

[mmattioli]

@grinich the links actually did not work and differ from the ones you have on your website. In addition, in #38 the CLA link doesn't work which I wanted to sign but can't since it's sorta...missing...

[mmattioli]

@grinich sorry to be a pest, just wondering what the status of this is. Thanks.

[mmattioli]

@spang, @grinich any sort of update on this?

[mmattioli]

@spang, @grinich I'm sure you guys hate me by now but I think that you guys manually committed the changes I described in this pull. I see you've updated the CLA link so I closed #38. Should this be closed as well?

[spang]

Yeah, I don't see anything else to do here. Closing, thanks.

[grinich]

Hi @mmattioli,

Thanks for the bugfix though! I think someone else came across these issues earlier and had a fix in the pipeline.

Please let us know if you find any other typos or have suggestions on improving the docs. Really appreciate you running through them in this detail. :)