[DOC] Minor fixes for job documentation

[landlord-matt]

Changes

Simply removing the migration section of control_run_state that is no longer needed and makes the rendered documentation look ugly. Also place the tags section last by Terraform documentation convention and fix remaining links.

Tests

• [ ] make test run locally
• [x] relevant change in docs/ folder
• [ ] covered with integration tests in internal/acceptance
• [ ] relevant acceptance tests are passing
• [ ] using Go SDK

[landlord-matt]

@mgyucht: Any thoughts on this? In my opinion these changes should be uncontroversial and will let everyone focus on the actual documentation without being distracted by these oversights.

[landlord-matt]

Perhaps Mr. @nkvuong? Sorry to always bother you.

[tanmay-db]

Hi @landlord-matt, to confirm before merging, why is the migration guide no longer needed? I understand that it's deprecated but still supported right? So we should have the migrating guide until it's no longer supported.

For the time being, I am going ahead with release without this PR since there are some bug fixes that we want to not blocked but will check up on this PR tomorrow for the next release.

[tanmay-db]

I will check back up on this PR tomorrow, please feel free to reply whenever comfortable with you.

[landlord-matt]

@tanmay-db : Thanks for reviewing. I think this PR will help everyone using Databricks Jobs with Terraform.

I reverted the change regarding the migration guide. My original thought was that the downsides of the ugly documentation index for the majority of people using recent versions outweighed the benefits for the minority of users that want to migrate in 2024.

Let's separate out this potential change regarding the migration guide to a separate PR in the future and merge these uncontroversial changes without it.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.55%. Comparing base (db53924) to head (7c74b74).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3543   +/-   ##
=======================================
  Coverage   82.55%   82.55%           
=======================================
  Files         187      187           
  Lines       19156    19156           
=======================================
  Hits        15815    15815           
  Misses       2413     2413           
  Partials      928      928