[Docs] Examples exception to the Charter

[woju]

Description of the changes

Exception voted in on 5 December 2023 during weekly call: #1660

TSC members, please ACK this PR, at least those who participated in the voting.

How to test this PR?

N/A

---

This change is 

[dimakuv]

ACK

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion, not enough approvals from maintainers (1 more required) (waiting on @boryspoplawski, @chiache, @donporter, @kailun-qin, @mkow, @monavij, and @woju)

---

CHARTER.rst line 265 at r1 (raw file):

(3) The directory `CI-Examples/` in main project repository, and the `examples`
    auxiliary repository (hereinafter “Examples”) serve as examples, templates
    and/or boilerplate for downstream projects that use gramine. Those Examples

Gramine (with capital letter)

[monavij]

ACK

[kailun-qin]

ACK

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, @mkow, and @woju)

---

CHARTER.rst line 267 at r1 (raw file):

    and/or boilerplate for downstream projects that use gramine. Those Examples
    should be available for reuse by downstream projects under permissive
    licence.

I understand it's british English, but the charter used "license" for all above, maybe we should align?

Code quote:

licence

[donporter]

ACK

[chiache]

ACK

[mkow]

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 8 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, @kailun-qin, and @woju)

---

-- commits line 2 at r1:
I have trouble parsing this sentence. Missing verb?

Code quote:

Examples exception to the Charter

---

-- commits line 4 at r1:
What's the point of this? You're the author of the commit...

---

CHARTER.rst line 243 at r1 (raw file):

Examples Exception

This is a bit confusing without the context, it's not obvious that this describes Gramine Examples, not just English noun "examples" capitalized because it's a heading. Maybe: "Gramine Examples Exception"?

---

CHARTER.rst line 261 at r1 (raw file):

    under terms incompatible with LGPL-3, which is fine. Nevertheless they need
    to copy and modify some boilerplate (like manifests), which might be
    available from our project.

Not sure if this construction works, sounds weird.

Suggestion:

available as part of our project

---

CHARTER.rst line 263 at r1 (raw file):

    available from our project.

(3) The directory `CI-Examples/` in main project repository, and the `examples`

Suggestion:

The `CI-Examples/` directory in the main project repository

---

CHARTER.rst line 267 at r1 (raw file):

Previously, kailun-qin (Kailun Qin) wrote…

I understand it's british English, but the charter used "license" for all above, maybe we should align?

Yes, we should change, we use am. eng. in Gramine.

---

CHARTER.rst line 281 at r1 (raw file):

   already licensed under permissive licence, by asking authors and/or
   copyright holders thereof to relicense their respective contributions under
   BSD-3-Clause licence.

Suggestion:

license.

[mkow]

Reviewable status: all files reviewed, 8 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, @kailun-qin, and @woju)

---

CHARTER.rst line 281 at r1 (raw file):

   already licensed under permissive licence, by asking authors and/or
   copyright holders thereof to relicense their respective contributions under
   BSD-3-Clause licence.

Actually, ditto in all other places.

[woju]

Reviewable status: 0 of 1 files reviewed, 8 unresolved discussions, not enough approvals from maintainers (1 more required), not enough approvals from different teams (1 more required, approved so far: ITL) (waiting on @boryspoplawski, @chiache, @dimakuv, @donporter, @kailun-qin, and @mkow)

---

-- commits line 2 at r1:

Previously, mkow (Michał Kowalczyk) wrote…

I have trouble parsing this sentence. Missing verb?

Done. Yes, missing "Add".

---

-- commits line 4 at r1:

Previously, mkow (Michał Kowalczyk) wrote…

What's the point of this? You're the author of the commit...

I'll list all people who acked. I think this needs to be in git log, not only in PR's comments on github.

---

CHARTER.rst line 243 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

This is a bit confusing without the context, it's not obvious that this describes Gramine Examples, not just English noun "examples" capitalized because it's a heading. Maybe: "Gramine Examples Exception"?

It's both gramine and non-gramine. It's all Gramine, since 1) this is within our project, and at the same time, 2) it's examples of other apps, right? And adding "Gramine" adds nothing to context, because 1).

---

CHARTER.rst line 261 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

Not sure if this construction works, sounds weird.

Too late for this change, unless you're arguing that we've voted on different version that I've posted in this PR.

---

CHARTER.rst line 263 at r1 (raw file):

    available from our project.

(3) The directory `CI-Examples/` in main project repository, and the `examples`

Ditto.

---

CHARTER.rst line 265 at r1 (raw file):

Previously, dimakuv (Dmitrii Kuvaiskii) wrote…

Gramine (with capital letter)

This I can correct I guess, it's a clerical error.

---

CHARTER.rst line 267 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

Yes, we should change, we use am. eng. in Gramine.

I don't think we should strive for unifying English dialects. Everyone should be writing whichever dialect they have been taught. This is software project, not language project.

---

CHARTER.rst line 281 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

Actually, ditto in all other places.

I don't think so. This is correct spelling.

[dimakuv]

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 8 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, @kailun-qin, and @mkow)

[kailun-qin]

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 8 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, and @mkow)

---

CHARTER.rst line 267 at r1 (raw file):

Previously, woju (Wojtek Porczyk) wrote…

I don't think we should strive for unifying English dialects. Everyone should be writing whichever dialect they have been taught. This is software project, not language project.

Sure, I agree. I'm resolving.

[mkow]

Reviewed all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, and @woju)

---

-- commits line 4 at r1:

Previously, woju (Wojtek Porczyk) wrote…

I'll list all people who acked. I think this needs to be in git log, not only in PR's comments on github.

What about me?

---

CHARTER.rst line 243 at r1 (raw file):

Previously, woju (Wojtek Porczyk) wrote…

It's both gramine and non-gramine. It's all Gramine, since 1) this is within our project, and at the same time, 2) it's examples of other apps, right? And adding "Gramine" adds nothing to context, because 1).

But here we're talking about very specific couple of repos, not examples in general (e.g. published/shared by other channels).

---

CHARTER.rst line 261 at r1 (raw file):

Previously, woju (Wojtek Porczyk) wrote…

Too late for this change, unless you're arguing that we've voted on different version that I've posted in this PR.

This is just a grammar fix to make the sentence clearer.

---

CHARTER.rst line 267 at r1 (raw file):

Previously, kailun-qin (Kailun Qin) wrote…

Sure, I agree. I'm resolving.

@woju: we've discussed this already many times, please keep the language consistent across our project, it's only you who is opposing this.

[mkow]

Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, and @woju)

---

CHARTER.rst line 267 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

@woju: we've discussed this already many times, please keep the language consistent across our project, it's only you who is opposing this.

Also, https://github.com/gramineproject/gramine/blob/master/CONTRIBUTING.rst#pull-requests.

[woju]

Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @boryspoplawski, @chiache, @donporter, and @mkow)

---

-- commits line 4 at r1:

Previously, mkow (Michał Kowalczyk) wrote…

What about me?

You did not ACK in this PR, so I can't include Acked-by: line for you.

---

CHARTER.rst line 243 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

But here we're talking about very specific couple of repos, not examples in general (e.g. published/shared by other channels).

This whole Charter is about what we publish in repo(s) only, not other channels.

---

CHARTER.rst line 261 at r1 (raw file):

Previously, mkow (Michał Kowalczyk) wrote…

This is just a grammar fix to make the sentence clearer.

You can propose an amendment, on which we'll vote.

---

CHARTER.rst line 267 at r1 (raw file):

it's only you who is opposing this

I think it's mosly you who care about this. I never understood why we should care about that. We should not try to unify how people speak and communicate.