Create a Glossary page

[jbogarthyde]

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

• Adapt content of Terminology to an alphabetized table format.
• Add terms as needed.
• Add links to Glossary on Doc Home Page and in Getting Started menu
• Link to terms in the glossary from the tech doc where necessary (first time term appears on a page or section)

See Umbrella Issue

[jbogarthyde]

Please add documentation label

[shubhusion]

/assign @jbogarthyde , @JustinCappos
Kindly assign this issue to me.

Interested in Contributing through LFX Mentorship

[Raunak2024]

Hi there! I have understood the issue and willing to work on it. So shall I get started? @jbogarthyde

[nate-double-u]

Hello, Thanks for your interest!

If you're looking to participate in the LFX Mentorship program, the best path is to apply via the LFX platform. Assignment on this particular issue before being accepted is premature.

[DarikshaAnsari]

@lukpueh @chalin Hi, I haven't started working on this issue yet. Could you please suggest where I should add this section to our website?

[lukpueh]

I don't know. Maybe as a subsection in docs? Between specs and faq?

[DarikshaAnsari]

so after adding this terminology section on glossary page. I have to remove it from the in-toto-spec.md.

[DarikshaAnsari]

So,My task is to create a glossary page containing a terminology table, link this page to the index of our documentation, and ensure that the first occurrence of any term in the documentation is linked to the glossary.

[lukpueh]

I don't think we want to remove it from the spec. I suggest to either just make the new glossary page point to the spec or duplicate for now (and make a note in DarikshaAnsari/in-toto-docs#22).

[lukpueh]

So,My task is to create a glossary page containing a terminology table, link this page to the index of our documentation, and ensure that the first occurrence of any term in the documentation is linked to the glossary.

Sounds like a plan. IIUC that would mean that you duplicate the glossary.

[DarikshaAnsari]

So,My task is to create a glossary page containing a terminology table, link this page to the index of our documentation, and ensure that the first occurrence of any term in the documentation is linked to the glossary.

Sounds like a plan. IIUC that would mean that you duplicate the glossary.

That's why I asked you to remove it from in-toto-spec.md.

[lukpueh]

I don't think we want to remove it from the spec. I suggest to either just make the new glossary page point to the spec or duplicate for now (and make a note in DarikshaAnsari/in-toto-docs#22).

☝️