Added docs for Config and Auth & update doc workflow

[Bobbins228]

Issue link

Closes #429

What changes have been made

The detailed "code orientated" docs have been moved to a new folder within docs called detailed-docs
The release workflow has been updated to account for this.
New docs were added for Cluster Configuration and Authentication

Ingress instructions in README moved to cluster-configuration.md

Verification steps

You can verify the workflow changes by running this command.

poetry run pdoc --html -o docs/detailed-documentation src/codeflare_sdk && pushd docs/detailed-documentation && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs/detailed-documentation -type f -name "*.html" -exec bash -c "echo '' >> {}" \;

You should get a docs/detailed-docs folder containing the detailed documentation.

Checks

• I've made sure the tests are passing.
• Testing Strategy
  • Unit tests
  • Manual tests
  • Testing is not required for this change

[VanillaSpoon]

Tiny nit, but other than that lgtm, great job @Bobbins228 :)

[VanillaSpoon]

lgtm :)

[ChristianZaccaria]

Looks great! I left a couple nitpicks.

[ChristianZaccaria]

You might need to rebase as well.

[Fiona-Waters]

This is great!
Just one comment. I think we should add a section intro to the jobs.html file, so that all sub_modules have one. I think the ... on this page looks like something is missing, especially with the whitespace underneath.

What would you think about making these into links so it's clearer where they are coming from? Just a thought.

[Bobbins228]

@Fiona-Waters
These html pages are generated off of comments in the code and so the modules jobs, cluster and utils would not generate any notes because they are folders within the SDK. There might be a way to add a description for these modules so that they are generated automatically but I think it would warrant a separate issue WDYT?

[Fiona-Waters]

@Fiona-Waters These html pages are generated off of comments in the code and so the modules jobs, cluster and utils would not generate any notes because they are folders within the SDK. There might be a way to add a description for these modules so that they are generated automatically but I think it would warrant a separate issue WDYT?

Is it not just a matter of adding a comment here like the one included for ray jobs here?

[Bobbins228]

@Fiona-Waters My bad I thought you meant the module yeah I can add a short desc of the DDP Jobs 👍

[Fiona-Waters]

/lgtm
/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Fiona-Waters

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [Fiona-Waters]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment