Document machine-to-machine auth options in openeo

[soxofaan]

ref: eu-cdse/openeo-cdse-infra#233

[soxofaan]

@JanssenBrm @rahmandawibowo-vito this probably needs some more work. I'm not sure what you need nowadays at the marketplace side of things to link client credential accounts with user accounts

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://eu-cdse.github.io/documentation/pr-preview/pr-613/
on branch gh-pages at 2024-09-16 13:47 UTC

[Pratichhya]

I assume as a first version of the document, it is good to be merged.

Minor changed in the sentences with regards to pronoun "you" has been done

[Pratichhya]

This too seems a bit longer title to me

[soxofaan]

To make it easy for people to find this I wanted to include "non-interactive" and "machine-to-machine" in the title. It also focuses heavily on python use cases, so I wanted to make that clear

[soxofaan]

made it bit shorter

[Pratichhya]

@KanerLev @Slegersj @bomansb FYI

[soxofaan]

Minor changed in the sentences with regards to pronoun "you" has been done

@Pratichhya just curious: what is the background of removing "you"? is that a style guide?

I also noticed you removed quite some newlines from my text, is that intentional?
Note that I intentionally use newlines in docs, following https://sembr.org/

[Pratichhya]

Minor changed in the sentences with regards to pronoun "you" has been done

@Pratichhya just curious: what is the background of removing "you"? is that a style guide?

@soxofaan, the reason to update sentences having "you" or "your" as pronouns was to maintain the idea adopted in PR #533 as suggested by @HansVRP. To limit the use of "you", instead, use "user" for consistent and academic writing.

I also noticed you removed quite some newlines from my text, is that intentional? Note that I intentionally use newlines in docs, following https://sembr.org/

Ahh, I am extremely sorry about the newlines style. I didn't know they were intentional and thought the markdown anyway read them as a single line. I will try to update these 😅

[soxofaan]

the reason to update sentences having "you" or "your" as pronouns was to maintain the idea adopted in PR #533 as suggested by @HansVRP. To limit the use of "you", instead, use "user" for consistent and academic writing.

Ok good to know, makes sense to add this to the guidelines (#612) I guess

[soxofaan]

thought the markdown anyway read them as a single line

Yes that's the point: from the standpoint of Markdown tools they are considered a single paragraph.
But the separate lines are much friendlier to other tools like git, GitHub pull requests, ...

[Pratichhya]

thought the markdown anyway read them as a single line

Yes that's the point: from the standpoint of Markdown tools they are considered a single paragraph. But the separate lines are much friendlier to other tools like git, GitHub pull requests, ...

Noted, thank you for the suggestion. I updated the changed sentences in the PR and will try to implement this in my other PRs too :)

[soxofaan]

Are there any open issues here I have to address or other todo's to get this merged?

[KanerLev]

Hi @soxofaan, I couldn't write earlier. Content-wise all OK from our side however to get it merged now please commit them directly to publish (not staging).

With the current operations flow we follow:
-all PRs are committing changes directly to publish e.g. see https://github.com/eu-cdse/documentation/pulls.
-staging is rebased afterwards

We are working with all stakeholders to introduce committing to staging before carrying them to public :
i.e.

• we commit to staging during a timeframe e.g. for a week
• e.g. once in every week we commit what's accumulated in staging to public

however we encounter several bottlenecks and still need time on them:

1. on the timeframe (some changes are asked to be public within hours/days)
2. on the technical level: staging and the staff need to be prepared for such flow.

If that doesn't suit you, let me know if it suits you that I create a new PR and commit these directly to publish.

Any other feedback / suggestions please share

[KanerLev]

Comment provided

[soxofaan]

Ok I'll rebase against the publish branch

However note that I expliclity chose staging because it is documented that way in the README:

documentation/README.md

Lines 16 to 17 in fe8c3b0

	## Other changes
	All other changes are made via a PR on the `staging` branch.

What is also not clear:

please commit them directly to publish (not staging).

do you really mean I should commit to the publish branch? Or do you mean that I should work in feature branch, branching off of publish and create a pull request targetting publish?

[KanerLev]

Ok I'll rebase against the publish branch

However note that I expliclity chose staging because it is documented that way in the README:

documentation/README.md

Lines 16 to 17 in fe8c3b0

	## Other changes
	All other changes are made via a PR on the `staging` branch.

What is also not clear:

please commit them directly to publish (not staging).

do you really mean I should commit to the publish branch? Or do you mean that I should work in feature branch, branching off of publish and create a pull request targetting publish?

On README: Indeed, thank you for highlighting, I'll edit

• README and
• other resources that needs to be edited in this scope e.g. https://github.com/eu-cdse/documentation/blob/publish/EU-CDSE_Documentation_Guidelines_v0.pdf (I also see guidelines PDF? #612, I'll check, thank once again for highlighting)

On "commit them directly to publish (not staging)": Thanks for asking constructively, I meant the second option ("that I should work in feature branch, branching off of publish and create a pull request targetting publish").

[soxofaan]

I rebased this pull request targeting the publish branch in PR #624