Add GH action job to deploy docs

[pankajastro]

closes: #279

This PR includes the following changes

1. Add CI job to deploy docs
2. Introduced command hatch run docs:dev to locally build and serve docs
3. Remove hatch run docs:serve command
4. Rename hatch run docs:build to hatch run docs: gh_deploy
5. Rename hatch run docs:release to hatch run docs: gh_release

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.68%. Comparing base (a85044c) to head (9291603).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #342   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files          10       10           
  Lines         792      792           
=======================================
  Hits          742      742           
  Misses         50       50           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pankajkoti]

It looks great to me @pankajastro . Have some minor suggestions in-line.

[tatiana]

@pankajastro excellent progress, and thanks for fixing the previous unintended publishing issue I introduced in #328

We should not publish documents using our personal credentials. Please let me know if you need support on this.

Please, could you also update the docs so they are correct:
https://github.com/astronomer/dag-factory/blob/main/docs/contributing/howto.md#write-docs

Some other concerns:

• It may be worth only to publish docs if static checks pass (and perhaps other tests, since we're exposing code)
• When we merge PRs to the main branch, I believe we should update the "dev" or "unstable" docs only
• We should probably update the "versioned" documents only when we publish a new version of DAG Factory to PyPI

[pankajkoti]

• When we merge PRs to the main branch, I believe we should update the "dev" or "unstable" docs only
• We should probably update the "versioned" documents only when we publish a new version of DAG Factory to PyPI

I believe these 2 are already taken care of, no?

[tatiana]

• When we merge PRs to the main branch, I believe we should update the "dev" or "unstable" docs only
• We should probably update the "versioned" documents only when we publish a new version of DAG Factory to PyPI

I believe these 2 are already taken care of, no?

You're right, @pankajkoti; these should be working as I described; I missed this in the first look!

[tatiana]

Thanks a lot for addressing all the feedback, @pankajastro , I'm super excited to see the improvements we're making to the docs published - with versions!

[tatiana]

@pankajastro please, before merging this PR, update the docs: https://github.com/astronomer/dag-factory/blob/main/docs/contributing/howto.md#write-docs