sap-docs / contribution-guidelines Goto Github PK

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/dos-and-donts.html

On the "Don't be despondent if your contribution is not accepted or actioned. While all contributions are assessed, it's likely that not all will be accepted."-part,..

Have you considered using "disappointed" instead of "despondent"? The latter seems an exaggeration of the feeling one might have when their feedback isn't accepted. I sincerely hope that no-one would get stuck in a depression over this :).

Granted, I'm not a native english speaker, so it might be related to my lack of understanding as well. In which case I'm pretty sure more people will understand disappointed over despondent ;).

https://help.sap.com/docs/PRODUCT_ID/contribution-guidelines/content-contribution_sap-terminology.html?state=PRODUCTION&version=1.0&locale=en-US

please correct the broken link.

Regards Britta

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/what-to-expect.html

Awesome idea. SAP Open Documentation Initiative. more collaboration.

SAP Community ID @yasin.n

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/content-contribution_sap-terminology.html?locale=en-US

Hi team,

I tried to access to the page "SAP Terminology" content but an error appears in page (some times): http://www.sapterm.com/application_page.htm I tried with different browsers.
When the error appears, the error say that "the page reject the connection".

Maybe it's better add directly the link to SAP help Glossary: https://help.sap.com/glossary/ that contains a more modern concepts.

Regards
Enric Castella

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/content-contribution_readme.html?locale=en-US

Good morning
I would like to know where to contribute in a translated language about the current content. Could you please create a section ?
I'm going to make a pool request about translation.
Thank you
Amaury

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/content-contribution_sap-terminology.html

Its a good Initiative, Thank you .

https://people.sap.com/andrew.diaz

Workflows refer to SAP_CODOC_APP_PEM but the secret is SAP_CODOC_APP_PEM_BASE64. Entirely my fault for leaving the WIP #50 over the long weekend.

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/content-contribution_readme.html?locale=en-US

Hellow,

Just a minor eyesore but the 'How to Contribute Content ' page has a different order in topics than the Navigation pane on the left side of the page.
More specifically the page first mentions 'Style Guidelines' followed by 'Use of SAP Terminology'. Compared to 'SAP Terminology' and then 'Style Guidelines' in the Navigation pane.

Kind Regards,
Stef

Issue description

The description of the Contribution Recognition in SAP Community references the URL https://people.sap.com/ as input for the recognition.

I think that after the last change on the SAP Community, this reference does no longer exist, at least I was not able to find this.

The documentation as well as the bot on GitHub that requests this info in issues, either needs to be updates or provide more details on how to find this information.

Feedback Type (Optional)

outdated information

Page Title on SAP Help Portal (prefilled)

https://github.com/SAP-docs/contribution-guidelines/blob/main/docs/recognition.md

Page URL on SAP Help Portal (prefilled)

https://github.com/SAP-docs/contribution-guidelines/blob/main/docs/recognition.md

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/readme.html?locale=en-US&version=1.0

https://help.sap.com/docs/open-documentation-initiative/contribution-guidelines/feedback.html

Hi there,

we encountered an issue today. Although the repos in the sap-docs org are public, a customer couldn't fork the repositories. I couldn't find any hint in the documentation what setting might limit forking public repositories. Let's see if we can find out the root cause. If so, it would be good to share this information in the contribution guidelines.

This is the error we got:

Refer to content in SAP-docs/.github to be consistent; remove unnecessary deviations and custom content.

When a pull request is opened, the Markdown linting process currently lints all files in the repo. This causes problems when the existing body of content doesn't follow the (new) linting rules yet.

We need to narrow the linting activity to just the documentation files in the pull request.

See #64 - this was created by cyberpinguin, closed, but reopened by je-hal. The first time we saw the disallowed-checker alert, the second time (after reopening) we didn't. Is this because je-hal (an admin) is the new actor here?

https://help.sap.com/webcomponents/products/open-documentation-initiative/contribution-guidelines/dos-and-donts.html

Don't ask for new features, nor for enhancements or changes to existing features.

I assume here that we mean new SAP product features or enhancements. But new features for the documentation would be acceptable? Because when I first read this sentence my mind was actually thinking documentation features or enhancements. Maybe we want to clarify that.

There is a link missing to the guidelines on SAP Help Portal. As I'm not allowed to contribute to the readme file, somebody else needs to add this:
SAP Help Portal

The documentation for the workflow says:

it adds a comment only after the first time the label [Contribution] is added

However, the comment is added every time the label is added, for example, check the following contributions of user qmacro:

https://github.com/SAP-docs/contribution-guidelines/pulls?q=is%3Apr+is%3Aclosed+author%3Aqmacro+label%3Acontribution

This leads to unnecessary comments and notifications.

This PR SAP-docs/btp-business-application-studio#14 caused a 'disallowed content' message to be generated. This is because the PR author @Shegox is not in the repo's admin team. We should extend the membership check to take into account organisation level members.

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/feedback.html

Hi, I just wanted to test the process. This is a great initiative. Thank you for bringing this to life!

See #62 and #60 user @hal-ey doesn't have admin permissions, but in this run the assign label step https://github.com/SAP-docs/contribution-guidelines/blob/main/.github/workflows/merged-pr-labeler.yaml#L54-L56 doesn't run, because, looking at the raw log output, the repo_permission env var doesn't exist:

2021-06-30T14:23:04.8609098Z ##[group]Run permission="$(gh api --jq .permission "/repos/$GITHUB_REPOSITORY/collaborators/$GITHUB_ACTOR/permission")"
2021-06-30T14:23:04.8610463Z �[36;1mpermission="$(gh api --jq .permission "/repos/$GITHUB_REPOSITORY/collaborators/$GITHUB_ACTOR/permission")"�[0m
2021-06-30T14:23:04.8611651Z �[36;1mecho "repo_permission=$permission" >> $GITHUB_ENV�[0m
2021-06-30T14:23:04.8661852Z shell: /usr/bin/bash -e {0}
2021-06-30T14:23:04.8662456Z env:
2021-06-30T14:23:04.8662890Z   LABEL: contribution
2021-06-30T14:23:04.8663532Z ##[endgroup]

To keep the contribution information clean, we should not assign the contribution label for activities performed by administrator users. This policy may change, but for now, we're getting too high a signal for valuable contributions.

https://help.sap.com/products/open-documentation-initiative/contribution-guidelines/readme.html?locale=en-US