SAP-docs / btp-developer-guide

Markdown source for the SAP BTP Developer's Guide. Enables feedback and contributions to improve the documentation.
Creative Commons Attribution 4.0 International
1 stars 4 forks source link

Markdown source doesn't match help.sap.com #5

Closed nicoschoenteich closed 1 year ago

nicoschoenteich commented 1 year ago

Issue description

Hi team,

I was looking into submitting a PR to change (improve) a few sentences this part of the SAP BTP Developers Guide, when I noticed that the markdown source didn't match what was shown on help.sap.com. See the screen shot below, GitHub on the left, help.sap.com on the right (both opened in private windows):

Screenshot 2023-11-14 at 09 13 05

The position of the image is different, there are text differences, and there is more content on the right. So now I'm wondering - do I not see the latest version on the left or right? What would happen to my PR if it conflicts with other changes that might have been made to the source already.

Thanks!

Best, Nico

Feedback Type (Optional)

other

Page Title on SAP Help Portal (prefilled)

Develop the User Interface

Page URL on SAP Help Portal (prefilled)

https://help.sap.com/docs/btp/btp-developers-guide/develop-user-interface?sprinklrid=11757247470

je-hal commented 1 year ago

Hi @nicoschoenteich,

thank you for making us aware of this. The version you see on help.sap.com is always the most current one. To keep the Markdown version on github.com in sync with what you see on SAP Help Portal, a manual action is required. Usually that's done together with a new release. So maybe wait until @ekaterina-mitova has done this before opening your PR. The markdown version on github.com is a week older.

Sorry for the inconvenience.

nicoschoenteich commented 1 year ago

Hi @je-hal,

Thanks for clarifying! I didn't know there was a separate process involved. I thought the markdown source was the actual single point of truth. Nevermind then.

How do I know when the GitHub source has been updated?

ekaterina-mitova commented 1 year ago

Hi @je-hal, the GitHub source is now updated.

je-hal commented 1 year ago

How do I know when the GitHub source has been updated?

Hi @nicoschoenteich, in github you can see it here: image

However, I don't think there is a way for externals to see when the latest update happened on SAP Help Portal. Anyway, if the last push to GitHub was done a long time ago, it's likely that someone forgot to push the button. However, other guides also have slower release cycles, so it can happen that the content on GitHub - despite being two months old - is actually up-to-date.

sap-doc-bot[bot] commented 1 year ago

Thank you for your valuable feedback contribution, @nicoschoenteich! So that we can recognize your contribution in SAP Community, please tell us your SAP Community profile URL in a reply to this comment; don't include any other text, just the URL on its own, like this:

https://people.sap.com/your-user-name

Thanks!

nicoschoenteich commented 1 year ago

https://people.sap.com/nicolai.geburek