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

Update README.md with a Glossary link #60

Merged
merged 3 commits into from
Nov 3, 2021
Merged

Update README.md with a Glossary link #60

merged 3 commits into from
Nov 3, 2021

Conversation

bourgeoa
Copy link
Member

@bourgeoa bourgeoa commented Oct 18, 2021

see issue #58

@bourgeoa bourgeoa requested a review from TallTed October 18, 2021 22:15
Copy link
Contributor

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

Small tweaks here.

I don't think there's a good place for me to log the follow-on issue — which is to include this link in the README for all Solid projects, and likewise to link to it from the first occurrence of anything in the [CENP]SS (etc.) morass — because it crosses so many repos.

Suggestions welcome!

README.md Outdated Show resolved Hide resolved
Co-authored-by: Ted Thibodeau Jr <[email protected]>
@jeff-zucker
Copy link
Member

The DEIT team decided to build a vocabulary of Solid terms and acronyms. I have been working on it for months. Eventually it can live on solidproject.org and be pointed to from there. Your feedbacks is welcome. Latest draft at the bottom of this page : I have uploaded my work on acronyms so far at solid/deit#15 (comment)

@bourgeoa
Copy link
Member Author

@jeff-zucker looks nice. Is there a way to work on it online. It shall replace the wiki Glossary as soon there is a link to your work even a work in progress one.

@jeff-zucker
Copy link
Member

jeff-zucker commented Oct 21, 2021 via email

@TallTed
Copy link
Contributor

TallTed commented Oct 21, 2021

I have no argument with solidproject.org as the home of this glossary. (I might well have opened this issue there, had I spent longer skimming the long list of Solid repos.)

I'm struggling to imagine any "terms specific to the server that we don't want to have in the main glossary", as their definitions can state that they're specific to (one or more of) the server(s), and certainly all Solid Servers seem to me to be part of the Solid Project.

@jeff-zucker
Copy link
Member

The way the glossary is organized, I try to focus on a limited number of terms to define in the document itself and point to others in other locations. For example I don't define ACL or ACP, I poiint to other documents that define them. I'm not sure I want to define websockets in the main glossary but NSS might.

@TallTed
Copy link
Contributor

TallTed commented Oct 21, 2021

I'm sure NSS doesn't want anything, either way. The people working on it might have reason to include a brief definition of websockets in an overall Solid-related glossary, which I can't think of a good reason against, which might include some pointer(s) to deeper/broader external/remote definition(s) (such as DBpedia, Wikipedia, RFC, W3C TR, etc.).

@bourgeoa
Copy link
Member Author

The wiki was mainly avoiding to define anything and just link to something existing that give food to curious. He just give the extended name :

[NSS](https:gitHub.com/solid/node-solid-server) : Node Solid Server

This mainly avoid review of definition.

@TallTed
Copy link
Contributor

TallTed commented Oct 21, 2021

I'm OK with the principle. I'd tweak the execution a bit --

NSS: acronym for [Node Solid Server](https://gitHub.com/solid/node-solid-server)

(No space preceding the colon; note that it's an acronym; link from the expansion rather than from the acronym)

@bourgeoa
Copy link
Member Author

@jeff-zucker looks nice. Is there a way to work on it online. It shall replace the wiki Glossary as soon there is a link to your work even a work in progress one.

https://github.com/solid/solidproject.org/blob/glossary/pages/glossary/glossary.md

@bourgeoa bourgeoa self-assigned this Nov 3, 2021
@bourgeoa bourgeoa merged commit b8f8fc4 into main Nov 3, 2021
@bourgeoa bourgeoa added the documentation Improvements or additions to documentation label Nov 14, 2021
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

Successfully merging this pull request may close these issues.

3 participants