Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kf 4175 docs site #196

Merged
merged 68 commits into from
Sep 14, 2023
Merged

Kf 4175 docs site #196

merged 68 commits into from
Sep 14, 2023

Conversation

ColmBhandal
Copy link
Contributor

@ColmBhandal ColmBhandal commented Aug 29, 2023

MLflow Sphinx docs converted from Discourse.

To run locally, navigate to docs then do make install and make run.

To see the ReadTheDocs build for this PR go here: https://canonical-mlflowcanonicalcom--196.com.readthedocs.build/en/196/

The Sphinx docs setup based on Canonical's starter pack: https://github.com/canonical/sphinx-docs-starter-pack.

Docs were based off the draft posts in Discourse. However, Discourse for MLflow will not be continued - the system of record for MLflow docs going forward is this GitHub repo.

MLflow posts on Discrouse (a subset of which comprise the docs): https://discourse.charmhub.io/tag/mlflow.

ColmBhandal and others added 28 commits August 15, 2023 17:31
Using reusable workflow instead
Allows it to be manually called
Added exception for spellcheck
Values seem to be in quotes
Pulled in latest starter pack changes
Removed "Documentation" - the site alredy appends "documentation"
Content as yet unchecked

Also updated some links
Made the content charm specific
Removed starter pack readme
Added version tables instead of V2 in heading/text
Little tweaks
* First version

* First version
Details is not a component
Dropdown comes from sphynix-design
Fixed links and inline code formatting
Fixed links and some wording
Fixed some broken things from Sphinx migration

Made some tweaks to wording
Fixed links

Made some tweaks
@ColmBhandal
Copy link
Contributor Author

Apart from the above, I see that a bunch of documentation-specific tests are failing, including the spelling and links ones. This is the time to fix any mistakes or adjust the tests.

Good point. I'll fix these. There are a LOT of spelling errors to fix.

@ColmBhandal
Copy link
Contributor Author

Apart from the above, I see that a bunch of documentation-specific tests are failing, including the spelling and links ones. This is the time to fix any mistakes or adjust the tests.

OK, spelling and links are fixed now.

Copy link
Contributor

@phoevos phoevos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor fixes.

There are also these 2 unresolved comments regarding the Ubuntu version:

balancer
CharmHub
CLI
DEX
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should either be dex or Dex (https://dexidp.io/).

docs/.wordlist.txt Show resolved Hide resolved
docs/.wordlist.txt Outdated Show resolved Hide resolved
docs/how-to/create-ck8s-aws.rst Show resolved Hide resolved
docs/how-to/deploy-mlflow-kubeflow-eks.rst Outdated Show resolved Hide resolved
docs/how-to/integrate-ml-ckf-ck8s.rst Outdated Show resolved Hide resolved
docs/tutorial/mlflow-kubeflow.rst Outdated Show resolved Hide resolved
docs/tutorial/mlflow-kubeflow.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
@phoevos
Copy link
Contributor

phoevos commented Sep 14, 2023

Closing the relevant comment but adding a note here so that we don't forget. This should ideally be documented in an issue: #196 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this file contains a number of characters. Although this might be rendered the same (not sure), it's not the same character as ' and editors will likely whine about it.
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow great catch!

Alphbabetically ordered
Removed mlflow lowercase

Fixed spelling issue
@ColmBhandal
Copy link
Contributor Author

Closing the relevant comment but adding a note here so that we don't forget. This should ideally be documented in an issue: #196 (comment)

#202

@ColmBhandal
Copy link
Contributor Author

I'm bypassing the review because of the deadline to get these published.

@ColmBhandal ColmBhandal merged commit 0efa301 into main Sep 14, 2023
11 of 12 checks passed
@ColmBhandal ColmBhandal deleted the KF-4175-docs-site branch September 14, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants