🎨 Add oss/cloud tags on doc for GA connectors

[arnaudjnn]

What

Avoid unnecessary sections to improve the doc reading experience.

Fix titles hierarchy and naming for consistency.

How

Add the following tags on the sections dedicated to oss:

<!-- env:oss -->
<!-- /env:oss -->

Add the following tags on the sections dedicated to cloud:

<!-- env:cloud -->
<!-- /env:cloud -->

Preview

When you are in the Cloud version all the OSS paragraphs are hidden

[timroes]

Is there a specific reason why we change the list syntax in all those files?

[arnaudjnn]

This is Prettier default conf. hyphen and asterisk are the same in markdown

[timroes]

Yes I know they are the same, but there is no setup that should run prettier on those files by default in the repository, so this might be a local setup in your IDE. We should in general not change a lot of unrelated syntax (like * into -) in a PR for something completely else. So We should make sure this PR is only touching adding the actual tags and changes related to it and not touching a lot of unrelated code in those files due to some local prettier setup.

[arnaudjnn]

Do you now what can I do to reverse the prettier changes?

[letiescanciano]

I'm not sure there's an easy way to do that, and since the "format" part is not in an isolated commit not sure reverting will help you.

What I would do:

• double check your IDE conf to see what's causing this changes
• maybe check how prettier is config on the project and match your IDE conf
• reset your changes and remove all format related changes.
  I usually use git reset --soft commitHash to reset my changes in case it's helpful.
  https://git-scm.com/docs/git-reset

[arnaudjnn]

@nataliekwong I handed over all the headers.

[letiescanciano]

I still see a lot of format/prettier changes included, making this PR having more changes that actually required.
Also, I see we are changing a lot of headers, example:
<img width="947" alt="Screen Shot 2022-11-11 at 9 04 27 AM" src="https://user-images.githubusercontent.com/45267095/201294231-0ee2a891-d954-4052-8b76-12c588c0b7d3.png”>

Is that intended?

My understanding (based on PR description) is that we just need to add <!-- env:oss —> or <!-- env:cloud —> tags to show specific docs depending on environment.

It would also be nice to have a small loom, where we can see an example of the changes

[arnaudjnn]

I still see a lot of format/prettier changes included, making this PR having more changes that actually required. Also, I see we are changing a lot of headers, example: <img width="947" alt="Screen Shot 2022-11-11 at 9 04 27 AM" src="https://user-images.githubusercontent.com/45267095/201294231-0ee2a891-d954-4052-8b76-12c588c0b7d3.png”>

Is that intended?

My understanding (based on PR description) is that we just need to add <!-- env:oss —> or <!-- env:cloud —> tags to show specific docs depending on environment.

It would also be nice to have a small loom, where we can see an example of the changes

Can you comment on where there is this image changes?

As I have to edit all the GA connectors pages, I also fix some inconsistency + title errors that's it.

You can view Tim's demo here (12min): https://airbyte.zoom.us/rec/play/3vKBGVdKQw_EHFGFEEO6INqk7M6NwCTXyJTe-3hDdfgL7j6P3z5_ccgul1KAw3lki8opsg-IsXUxdmHl.a80AuC9qhhm8mHP7?continueMode=true&_x_zm_rtaid=9ZWepYheRw2rTR4gkxa3rA.1668421487226.86307acafb206ef549ab27dab128c422&_x_zm_rhtaid=241

[letiescanciano]

I still see a lot of format/prettier changes included, making this PR having more changes that actually required. Also, I see we are changing a lot of headers, example: <img width="947" alt="Screen Shot 2022-11-11 at 9 04 27 AM" src="https://user-images.githubusercontent.com/45267095/201294231-0ee2a891-d954-4052-8b76-12c588c0b7d3.png”>
Is that intended?
My understanding (based on PR description) is that we just need to add <!-- env:oss —> or <!-- env:cloud —> tags to show specific docs depending on environment.
It would also be nice to have a small loom, where we can see an example of the changes

Can you comment on where there is this image changes?

As I have to edit all the GA connectors pages, I also fix some inconsistency + title errors that's it.

You can view Tim's demo here (12min): https://airbyte.zoom.us/rec/play/3vKBGVdKQw_EHFGFEEO6INqk7M6NwCTXyJTe-3hDdfgL7j6P3z5_ccgul1KAw3lki8opsg-IsXUxdmHl.a80AuC9qhhm8mHP7?continueMode=true&_x_zm_rtaid=9ZWepYheRw2rTR4gkxa3rA.1668421487226.86307acafb206ef549ab27dab128c422&_x_zm_rhtaid=241

Understood about the titles.
About the demo, I understand that these tags were created by the FE team and I saw there presentation. My ask is that we demo the changes INCLUDED in this PR, just a way to showcase an example of your work and provide context to the reviewer.

[arnaudjnn]

@letiescanciano

I added 2 screenshots accordingly

[letiescanciano]

@Amruta-Ranade this is ready for your review

[Amruta-Ranade]

Thanks for all the work, @arnaudjnn !!

[timroes]

Syntax looks good to me. Have not tested locally.