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

Fix spec related files #13

Closed
chalin opened this issue Aug 6, 2024 · 2 comments · Fixed by #17
Closed

Fix spec related files #13

chalin opened this issue Aug 6, 2024 · 2 comments · Fixed by #17

Comments

@chalin
Copy link
Collaborator

chalin commented Aug 6, 2024

Originally posted by @chalin in #7 (review)

One main issue remains regarding the specs page.

What you should have in this PR is the following:

  • data/specs.yaml - same as the current site
  • layouts/shortcodes/spec-table.md - shortcode that generates the specs table in Markdown; it will be very similar to the current site's layouts/shortcodes/specs.html shortcode, but will use Makrdown instead of HTML in the shortcode. If you can't figure this out, embed the hardcoded table for now and I'll show you how we can do this in a followup PR.
  • content/en/docs/specs.md - a page that simply references the shortcode using {{% spec-table %}}.
@DarikshaAnsari
Copy link
Owner

@chalin I think this issue is already resolved in #9. Can I close this issue ??

@chalin
Copy link
Collaborator Author

chalin commented Aug 6, 2024

@chalin I think this issue is already resolved in #9. Can I close this issue ??

No, it cannot be closed because it has not been resolved. Let me explain.

For example, in the opening comment to the issue, the first bullet says that there should be a file named data/specs.yaml in this repo.

But if you look in https://github.com/DarikshaAnsari/in-toto-docs/tree/main/data, there is no such file at the moment (see the image below), so why do you feel that this has been resolved?

Similar comments apply to the other two files that are currently not a part of this repo.


image

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 a pull request may close this issue.

2 participants