Keep pages DRY

[chalin]

Originally posted by @chalin in #11 (comment)

@DarikshaAnsari - I believe that you copied this from the README of the demo repo. We don't want the same information in two places, so either the README will need to be shortened, and a link added to this page (once it becomes a part of the official site), or we can find a way later to fetch the page a build time.

I'll let @lukpueh comment on his preference here.

[chalin]

@lukpueh also commented in the following:

#11 (review)

• I like that the buttons and links on the landing page navigate to subpages inside docs. Maybe we can make this more consistent. That is, we map all buttons/links on the landing page to subpages . E.g. we could make "demo" and "friends" subpages in docs, to which "Try the demo" and "Explore integrations" point to. Those pages can then contain a short description of demo and friends repos and pointers to those repos. I think that might be a less disruptive experience, compared to when the user is directed to external pages right away on the landing page.

By short description I meant a paragraph or so and not the complete README from the demo and friends repos. Replicating all of this content on the website means that we have to either maintain it in two places, or remove it in its original place. Both of which does not seem desirable.

#11 (comment):

Hey @lukpueh, you're right, but I believe the friends section looks nice on the website rather than residing in the README of any GitHub repository. Additionally, for the demo, it's beneficial for all the contributors and integrators of the project to have the demo on one website instead of having to jump to another link placed on GitHub. I think you get my point. I've taken reference from many CNCF documentation websites that do exactly the same, including OpenTelemetry,KCL and many more.

Okay, I'm still not happy of maintaining the exact same content in two places, but I won't insist. Let's have other in-toto project maintainers weigh in, when we merge this upstream.

We should not have the same content in two places. A solution will need to be found. We could pull in the sources from the other repo's at build time, or you could simply write a short description as @lukpueh originally intended.

[chalin]

From #11 (comment), @DarikshaAnsari wrote:

@chalin @lukpueh I’m thinking of keeping the Adopters and Integrations page because it looks great on the website. Instead, I will update the README content for Friends on GitHub and link it to our website after deploying.

[chalin]

Closing in favor of:

• [docsy] Keep things DRY - avoid copy-pasted content from other repos in-toto/in-toto.io#75