Tracking issue for all links and placeholder docs in our GA site.
hsaliak opened this issue · comments
Main page:
- Works Across All platforms and Start quickly and scale both lead to quickstarts. @zinuga
- Bi-directional streaming and auth does not lead anywhere. @zinuga
- Get started at bottom of page does not lead anywhere. @zinuga
- Quickstarts at bottom of page need to be populated. @zinuga
- Community link at bottom of page links to github.com/grpc/grpc.github.io , whereas fork me on github leads to github.com/grpc/grpc @zinuga to change this to `github.com/grpc/grpc``
About page:
- Presentation and Talks on 'About page' are placeholders to non gRPC content.
- "For more background on why we created gRPC, read the gRPC Motivation & Design Principles blog" This leads back to the about page, needs to be referenced to the right blog post. Also, the linked text is not bolded. @zinuga
Docs page:
- All links in the docs page just point back to itself and need to be updated.
Quickstarts page:
- Currently the main page text is just a placeholder, this needs to be updated with the right content.. @hsaliak
Blog page
- Subscribe to blog goes nowhere, we need to update this. @zinuga Needs to connect to mailchimp account.
Community page
- The "or shortcut to.." links are not correctly set. @ejona86
- Join the mailing list opens up an email to the mailing list, it should direct to the correct google groups link @ejona86
@zinuga can you clarify where some of the missing links should point to?
Please also look at the docs page, especially the parts about "gRPC by use cases"
Have a PR in to fix a lot of the homepage and about page issues
#268
More to follow in a separate PR.
Thanks Varun, PR looks good, can you also check off some of the issues this addresses after I merge it in?
- list item text should be lighter (it is too dark), to match surrounding paragraphs (#271)
- Bullets points on the new site look awkward, I think there is unnecessary stylistic variation which gives it an inconsistent feel. Example screenshot:
- Switch all references to http://grpc.io/release to https://grpc.github.io/release @dgquintas
@hsaliak I don't think swapping to https://grpc.github.io/release does any good, because it redirects to http://www.grpc.io/release. So it gives a better appearance but doesn't address the actual issue.
@hsaliak, @dgquintas Instead of having people curl /release, why don't we just use {{ site.data.config.grpc_release_branch }} directly in the markdown?
@ejona86 that's actually a great idea. Talk about over-engineered solutions...
@ejona86 thanks for spotting that, i followed the redirects, not what i expected..
- Remove extraneous indentation in all code snippets. There is very little vertical space, we shouldn't squander it on indentation that applies to all lines in the snippet. @ejona86
- Word-wrap lines. In general, markdown is supposed to be word-wrapped because it may be read like a txt file. This is purely nice to have, can happen at any time, and has no visible impact on the website. @dgquintas
- There are two C# quickstarts: one in
docs/quickstart/csharp.mdand another one atdocs/quickstarts/csharp-quickstart.md. I suggest (re)moving the latter @apolcyn
@dgquintas sorry missed that #288 moves the quickstart that is currently committed.
- Community page says "You can reach us via... IRC" but doesn't provide the IRC channel information @hsaliak
@ejona86 it's a test! Shrewd users only :P
- Contribution guidelines can overlap with header. (ignored)
- For the final release, double check that Android helloworld points at the right place. It was moved post-pre2 when routeguide was added, so references to it have a high chance of being wrong
Fixed community page IRC link
Removed blog post sign ups.
- Delete
docs/guides/hello.md. It's not been recently reviewed, and is guaranteed to out-of-date (@hsaliak)
Calling it done.