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

Create Getting Started Guide #35

Open
6 tasks
Tracked by #221
jbogarthyde opened this issue Jan 30, 2024 · 5 comments
Open
6 tasks
Tracked by #221

Create Getting Started Guide #35

jbogarthyde opened this issue Jan 30, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@jbogarthyde
Copy link

jbogarthyde commented Jan 30, 2024

UPDATE 05/27/2024 (transfer issue from in-toto/docs and update issue description)

Information that is needed by new users is currently in GitHub readme files and in the Specification. Adapt and move the information to source files for the web-based documentation. See Umbrella Doc Issue

  • Create source file in user-doc source directory. (see Remove method field in signature object examples specification#34)
    Document title is "Getting Started" in the doc source directory.
  • Move the content of https://github.com/in-toto/in-toto/blob/develop/README.md to the GettingStarted.md file.
  • Add the new Getting Started document to the makefile for the static site generator.
  • Add a link to the new Getting Started document as the first item on the Doc home page TOC.
  • Add a link to the new Getting Started document as the first menu item of the "Get Started" menu on the main website.
  • Adjust the README content.
    Replace the README for the docs repo with content that briefly describes the project from a Contributor point of view, and provides links to resources, including contributor instructions, the new Getting Started Guide, and so on.
@jbogarthyde
Copy link
Author

Please add the documentation label to this issue

@Ayush9026
Copy link

/assign i will solve this issue.

@lukpueh
Copy link
Member

lukpueh commented May 21, 2024

Please coordinate with @DarikshaAnsari, who is working on setting up the docs scaffolding in in-toto.io. See #34

@Ayush9026
Copy link

@lukpueh Sir thank you for the update! I will coordinate and ensure our efforts are aligned. We will make sure to integrate the new "Getting Started" guide smoothly into the existing docs scaffolding on in-toto.io.

@DarikshaAnsari
Copy link
Contributor

Hey @lukpueh
Regarding the proposed name change for this repo from "docs" to "specification," I believe we can skip updating the README.md from a contributor standpoint. Since the purpose of this repo is shifting, there's no immediate need to update the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants