[En] add Host #3524
[En] add Host #3524
Conversation
This has been a long time coming after I initially submitted this idea years ago! As best as I can tell, this is similar to the "service" / "microservice" relationship, so I've tried to model this doc after the "service" one. I've added a bit of context about "host" that isn't present in "nodes", but maybe it's unnecessary? Feedback definitely appreciated. Signed-off-by: Jason Rhodes <[email protected]>
jasonrhodes
requested review from
caniszczyk,
seokho-son,
iamNoah1,
jihoon-seo,
nate-double-u,
Okabe-Junya and
hlipsig
as code owners
✅ Deploy Preview for cncfglossary ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-project-automation
bot
moved this to 📋 Backlog
in CNCF glossary definition review board
There was a problem hiding this comment.
A quick housekeeping note from the style guide: please use semantic line breaks to ease review (and localization efforts later).
I hope to do a more thorough review this week, thanks so much for coming back to this term @jasonrhodes!
deploy preview: https://deploy-preview-3524--cncfglossary.netlify.app/host/
There was a problem hiding this comment.
I really like the simplicity of this description. However, usually we have a certain structure that we follow for this category., ie: Problem it Addresses and How it helps. But for this term I don't really see how we should press into this template ^^, I am curious if some other maintainer has an idea how to proceed.
Appart from that the content is nice, just have a look at the failing spell and link check.
Yeah, I saw that, but was trying to model this after the "service.md" file that abandons those sections and opts for a link to "microservice.md" instead. Happy to take a stab at those sections if that seems necessary. |
Signed-off-by: Jason Rhodes <[email protected]>
Signed-off-by: Jason Rhodes <[email protected]>
|
I've added semantic line breaks and fixed the failing "LINKS" check by adding the missing trailing slash to the nodes link. The spellcheck is failing due to the use of "hostname", which is the word I intended to use. Is there a way to specify that it's valid or does it need to be rewritten to "host name" just to pass this check? Thanks! |
Thanks!
You can add it to the |
|
Thank you for your contribution, As Nate and Noah mentioned above, I think
to move forward with this PR. Thank you |
Signed-off-by: Jason Rhodes <[email protected]>
@nate-double-u got it, I've added "hostname" there, thanks.
@Okabe-Junya I definitely agree. That was why I modeled this change after the other "redirect" style of definition in the glossary already. Please take a look at the current service definition file. If you all would like these "redirect" definition files to include the same sections as the others, I'd like some guidance on how to approach it. Copy/paste from the target? Thanks. |
|
The last line of this new "host" file and of the mentioned "service" file both use "Please see the [target] definition", these could be expanded to say "For more about the problem it addresses and how it helps, please see the [target] definition" if that helps tie the formats together? Interested in more feedback here. |
|
After a quick chat with maintainers, we seem to agree that we want to keep the articles following the structure. However, the question is if we can even say "what problem it solves" etc per sé as the term host might be seen as a synonym to service, VM, server, container. Meaning that these terms talk about what problem they solve already. Lets discussing here @nate-double-u @hlipsig @jihoon-seo @seokho-son @Okabe-Junya |
|
Thank you for pointing out, Jason, Noah! I see... The "Problem it addresses" section is indeed very difficult. I've thought about this term many times, and I think that "host" would be a conceptual/abstract term rather than a term for solving specific problems (as you all say, that's already explained by other existing terms). How about an option where we keep only the "How it helps" section and omit the "Problem it addresses" section? Thank you again for your contribution and discussion :) |
|
IMO, while it's important to follow the established template, there may be terms that are difficult to fill in the "Problem it addresses" section and the accompanying "How it helps" section in the template, and I think the term "Host" that Jason is trying to add in this PR is one of those. So I think it would be nice to allow exceptions when necessary.. :) |
|
Ok, so the baseline is we allow to omit the sections when it is necessary, so for this case we skip both then? What you think? @nate-double-u @seokho-son @hlipsig |
|
Sorry for the late reply. It looks like Nate and Seokho reacted "+1" for Noah’s comment. (I'll review this PR later) |
There was a problem hiding this comment.
@jasonrhodes I am happy to approve now that we have a consensus amongst maintainers. Thanks again for the effort :)
Signed-off-by: Junya Okabe <[email protected]>
github-project-automation
bot
moved this from 📋 Backlog
to ✅ Done
in CNCF glossary definition review board
Describe your changes
This has been a long time coming after I initially submitted this idea years ago!
As best as I can tell, this is similar to the "service" / "microservice" relationship, so I've tried to model this doc after the "service" one. I've added a bit of context about "host" that isn't present in "nodes", but maybe it's unnecessary? Feedback definitely appreciated.
Related issue number or link (ex:
resolves #issue-number)Resolves #1308
Checklist before opening this PR (put
xin the checkboxes)git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to yourgitconfigby runninggit config --global alias.ci "commit -s".