Skip to content
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

Added New pages #11

Merged
merged 9 commits into from
Aug 29, 2024
Merged

Added New pages #11

merged 9 commits into from
Aug 29, 2024

Conversation

DarikshaAnsari
Copy link
Owner

@DarikshaAnsari DarikshaAnsari commented Aug 5, 2024

Copy link

netlify bot commented Aug 5, 2024

Deploy Preview for in-toto-docs ready!

Name Link
🔨 Latest commit b5bc31c
🔍 Latest deploy log https://app.netlify.com/sites/in-toto-docs/deploys/66d003cde4dd30000887f9fb
😎 Deploy Preview https://deploy-preview-11--in-toto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A first round of comments.

Please run npm run fix:format and commit the changes.

content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/_index.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created the following to track this issue, since @lukpueh and I agree that we do not want replicated content:

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, once the paths to images are fixed in Adopters.

content/en/ecosystem/adopters/index.md Outdated Show resolved Hide resolved
content/en/ecosystem/integreations/index.md Outdated Show resolved Hide resolved
@DarikshaAnsari DarikshaAnsari requested a review from chalin August 11, 2024 12:22
@DarikshaAnsari
Copy link
Owner Author

cc:- @lukpueh

Copy link
Collaborator

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice progress! Though it does not fully address #8, or at least not as requested. Did you disagree with my comments? Or was I just unclear. :)

  • 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.

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

This does not seem resolved.

  • Regarding content I am not sure if we should follow the recommendation from the cncf assessment and just re-publish the docs from python-in-toto as Getting started page. The documentation should represent the whole in-toto project, but the python-in-toto cli is only one of multiple in-toto implementations.

Same as above with demo and friends content.

content/en/_index.md Outdated Show resolved Hide resolved
@DarikshaAnsari
Copy link
Owner Author

Nice progress! Though it does not fully address #8, or at least not as requested. Did you disagree with my comments? Or was I just unclear. :)

  • 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.

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

This does not seem resolved.

  • Regarding content I am not sure if we should follow the recommendation from the cncf assessment and just re-publish the docs from python-in-toto as Getting started page. The documentation should represent the whole in-toto project, but the python-in-toto cli is only one of multiple in-toto implementations.

Same as above with demo and friends content.

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.

@DarikshaAnsari DarikshaAnsari requested a review from lukpueh August 13, 2024 15:19
@lukpueh
Copy link
Collaborator

lukpueh commented Aug 19, 2024

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

If you don't want to fix this now, but close #8, please submit another issue so we can fix this separately.

@DarikshaAnsari
Copy link
Owner Author

  • Why are there two search bars, one in the right top corner and one in the left navigation column? (no need to fix this now, I'm just curious)

I think this is the layout of google docsy.

@lukpueh
Copy link
Collaborator

lukpueh commented Aug 19, 2024

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.

Copy link
Collaborator

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can fix the get started link in a separate PR.

This was referenced Aug 22, 2024
Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going along with @lukpueh's approval. We can address the remaining issues via:

@DarikshaAnsari DarikshaAnsari requested a review from lukpueh August 23, 2024 19:10
@DarikshaAnsari
Copy link
Owner Author

@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.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rebase and ensure that all tests pass. Other than the one suggestion (see the inline comment), this LGTM under the assumption that you'll be following up with further changes.

<a class="btn btn-lg btn-primary me-3" href="https://github.com/in-toto/demo">Try the demo</a>
<a class="btn btn-lg btn-primary" href="https://github.com/in-toto/friends">Explore integrations</a>
<a class="btn btn-lg btn-primary me-3" href="docs/demo">Try the demo</a>
<a class="btn btn-lg btn-primary" href="ecosystem/">Explore integrations</a>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A link to the "Ecosystem" is in the top nav. We don't need a CTA button for this IMHO.

Suggested change
<a class="btn btn-lg btn-primary" href="ecosystem/">Explore integrations</a>

@DarikshaAnsari
Copy link
Owner Author

@chalin @lukpueh Can I merge this PR now.

@chalin
Copy link
Collaborator

chalin commented Aug 28, 2024

@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.

👍🏻 will track this followup via #22.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run npm run fix:format and commit changes; otherwise, this LGTM

@DarikshaAnsari
Copy link
Owner Author

I have used npm run fix:format and after adding the code it is showing everything is uptodate.

PS C:\Users\asus\Documents\Opensource\myproject> git push origin patch-newpages
Everything up-to-date

@chalin
Copy link
Collaborator

chalin commented Aug 28, 2024

I have used npm run fix:format and after adding the code it is showing everything is uptodate.

PS C:\Users\asus\Documents\Opensource\myproject> git push origin patch-newpages
Everything up-to-date

Right. You'll need to merge #27 first, then rebase this PR, resolve conflicts, re-run fix:format, and commit the results :).

@DarikshaAnsari DarikshaAnsari merged commit 2f89256 into main Aug 29, 2024
5 checks passed
@chalin chalin deleted the patch-newpages branch August 29, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misc comments
3 participants