keda-docs icon indicating copy to clipboard operation
keda-docs copied to clipboard

Added Reference section, Glossary, removed non-inclusive language.

Open dwelsch-esi opened this issue 1 year ago β€’ 3 comments

  • Added Reference section to table of contents, issue #1366
    • Moved some content from KEDA concept topics to Reference.
  • Added a glossary, issue #1367
  • Removed non-inclusive language, issue #1373

https://github.com/kedacore/keda-docs/issues/1366 https://github.com/kedacore/keda-docs/issues/1367 https://github.com/kedacore/keda-docs/issues/1373

Umbrella issue for CNCF tech docs recommendations: https://github.com/kedacore/keda-docs/issues/1361

Provide a description of what has been changed

Checklist

  • [x] Commits are signed with Developer Certificate of Origin (DCO)

Fixes #

dwelsch-esi avatar May 10 '24 21:05 dwelsch-esi

Thank you for your contribution! πŸ™ We will review your PR as soon as possible.

While you are waiting, make sure to:

  • Add your contribution to all applicable KEDA versions
  • GitHub checks are passing
  • Is the DCO check failing? Here is how you can fix DCO issues

Learn more about:

github-actions[bot] avatar May 10 '24 21:05 github-actions[bot]

Deploy Preview for keda ready!

Name Link
Latest commit b59f045c3b8f3eda0c2f77b02a1f77a5fa2b5af1
Latest deploy log https://app.netlify.com/sites/keda/deploys/667eb52c432edd0008c2823c
Deploy Preview https://deploy-preview-1389--keda.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 10 '24 21:05 netlify[bot]

Hey, mind fixing the build issue?

Thanks for opening the PR!

tomkerkhove avatar May 16 '24 12:05 tomkerkhove

I've taken a pass at fixing the build errors over on https://github.com/dwelsch-esi/keda-docs/pull/1 @dwelsch-esi, i'm not sure that this PR introduced all of the broken links though. Regardless, I hope the PR into your fork fixes them πŸ™‚

nate-double-u avatar May 29 '24 20:05 nate-double-u

Thank you!

tomkerkhove avatar May 30 '24 08:05 tomkerkhove

It looks like we are missing to add the newly introduced files to the 2.14 directory. Given that 2.14 is the latest version, all new additions to the next version (v2.15) must be backported to 2.14 for CI to pass.

Also, there's no need to update the params.version array in config.toml; this should only be edited during the release cycle by a release engineer.

Will push some changes to fix CI right away.

thisisobate avatar Jun 04 '24 23:06 thisisobate

Thanks @thisisobate. @tomkerkhove would you like to take a look now the build's not broken 😊

nate-double-u avatar Jun 04 '24 23:06 nate-double-u

I will do so ASAP, but can you elaborate on the changes in 2.14 which only adds things and not change other parts? Maybe it's best if we just focus on 2.15 and move forward

tomkerkhove avatar Jun 05 '24 07:06 tomkerkhove

@tomkerkhove The top level nav contains an FAQ link which reference the latest version. Making changes to just 2.15 will cause CI to break because the url structure is not the same: docs/2.14/faq vs docs/2.15/reference/faq.

thisisobate avatar Jun 05 '24 07:06 thisisobate

@tomkerkhove Honestly, I wouldn't think much about this implementation since it only fixes the CI. All the new changes to directory structure and docs will only reflect in 2.14 (latest version) and beyond.

thisisobate avatar Jun 05 '24 08:06 thisisobate

@tomkerkhove Honestly, I wouldn't think much about this implementation since it only fixes the CI. All the new changes to directory structure and docs will only reflect in 2.14 (latest version) and beyond.

So if I get it correctly, we are only adding the new pieces to make CI happy due to new navigation, is that correct? If so, then why don't we delete the old locations in 2.14? If somebody needs to update docs for 2.14 (ie typo or wrong content) then they need to update 2 places (and know there are 2).

tomkerkhove avatar Jun 05 '24 08:06 tomkerkhove

So if I get it correctly, we are only adding the new pieces to make CI happy due to new navigation, is that correct?

Yes, that is correct

thisisobate avatar Jun 05 '24 08:06 thisisobate

why don't we delete the old locations in 2.14? If somebody needs to update docs for 2.14 (ie typo or wrong content) then they need to update 2 places (and know there are 2)

what locations are you referring to? can you give me examples?

thisisobate avatar Jun 05 '24 08:06 thisisobate

Pretty much all of the content in 2.14, for example:

  • You introduced content/docs/2.14/operate/cloud-events.md
  • This is already in content/docs/2.14/operate/events.md

tomkerkhove avatar Jun 05 '24 20:06 tomkerkhove

Oh…I see. You’re correct. We should remove duplicates/files in old location.

cc: @dwelsch-esi https://github.com/dwelsch-esi

On Wed, 5 Jun 2024 at 21:38, Tom Kerkhove @.***> wrote:

Pretty much all of the content in 2.14, for example:

  • You introduced content/docs/2.14/operate/cloud-events.md
  • This is already in content/docs/2.14/operate/events.md

β€” Reply to this email directly, view it on GitHub https://github.com/kedacore/keda-docs/pull/1389#issuecomment-2150924221, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHBQHRSZ3VVDWKTGZEHLEGTZF5ZNHAVCNFSM6AAAAABHRJCSBGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJQHEZDIMRSGE . You are receiving this because you were mentioned.Message ID: @.***>

thisisobate avatar Jun 05 '24 21:06 thisisobate

@dwelsch-esi Are you still working on this or waiting for a re-review? I am asking since some things are still open and nothing was pushed.

tomkerkhove avatar Jun 19 '24 12:06 tomkerkhove

Thanks, I agree but wanted to hear from @zroubalik or @JorTurFer first

tomkerkhove avatar Jun 27 '24 05:06 tomkerkhove

Thanks @dwelsch-esi!

tomkerkhove avatar Jun 28 '24 13:06 tomkerkhove