Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

New docs structure #188

Merged
merged 109 commits into from
Oct 27, 2022
Merged

New docs structure #188

merged 109 commits into from
Oct 27, 2022

Conversation

mike0sv
Copy link
Contributor

@mike0sv mike0sv commented Oct 4, 2022 •
edited by aguschin
Loading

Docs structure overhaul as discussed in #179
This PR is meant to replace #179 and #182

What was done:

  • Created subpages for all major features (models/data/serving/building/deploy) in user-guide for each
  • Moved there hand-crafted documentation from extension docs in Docs for extensions #179
  • index pages are from GS
  • Renamed Extension section into Object Reference
  • restructured it. was: <ext type>/<ext name>, now: <object group>/<ext name>. Now multipurpose extensions (eg docker has build & deploy) has two pages
  • Object Reference is now fully autogenerated
  • Added builtin implementations there too
  • Moved details about mlem abcs and mlem objects from UG
  • Rewritten GS
  • New User Guide pages
  • New Object reference index pages written
  • Use Cases cleaned up

TODO:

  • rewrite GS Deployment
  • rewrite UG Deployment (+ explain what State is)
  • update UG Heroku
  • merge UG K8s @madhur-tandon
  • update UG Sagemaker - @mike0sv, there are your TODOs left
  • write UG Docker @madhur-tandon
  • update CLI reference
  • update API reference
  • merge UG export to venvs @madhur-tandon
  • rewrite Project structure
  • update UC - remote .mlem/ dir and mlem.api.ls mentions
  • search and remove all other mentions of .mlem/ dir and mlem.api.ls
  • search and update all other mentions of mlem init
  • search and update all other mentions of --conf or -c
  • fix broken links @madhur-tandon
  • add mlem checkenv to command reference. Why it wasn't generated I wonder?

@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 4, 2022 17:47 Inactive
@github-actions
Copy link

github-actions bot commented Oct 4, 2022 •
edited
Loading

2422c20

Link Check Report

3/180 links failed.

CML watermark

@mike0sv mike0sv changed the base branch from main to release/0.3.0 October 5, 2022 10:30
@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 5, 2022 11:21 Inactive
@aguschin aguschin mentioned this pull request Oct 5, 2022
Merged
@aguschin aguschin marked this pull request as ready for review October 5, 2022 13:58
@aguschin aguschin marked this pull request as draft October 5, 2022 13:58
@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 27, 2022 09:21 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 27, 2022 09:58 Inactive
@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 27, 2022 09:59 Inactive
@aguschin aguschin marked this pull request as ready for review October 27, 2022 09:59
@shcheklein shcheklein temporarily deployed to mlem-ai-new-docs-struct-hy95mv October 27, 2022 10:06 Inactive
aguschin
aguschin approved these changes Oct 27, 2022
View reviewed changes
Copy link
Contributor

@aguschin aguschin left a comment

Choose a reason for hiding this comment

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

Ok guys, that was a big deal! Thanks @mike0sv @madhur-tandon @jorgeorpinel @shcheklein

image

Ready to be merged! And improved 😂 god help us all

jorgeorpinel
jorgeorpinel reviewed Oct 27, 2022
View reviewed changes
content/docs/user-guide/data/numpy.md
Comment on lines +6 to +8
## Description

**TODO**
Copy link
Contributor

Choose a reason for hiding this comment

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

I see 11 TODOs in the changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is not getting to the website. These are just page stubs, without links in the sidebar.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can they be found by search engines btw?

Copy link
Contributor

Choose a reason for hiding this comment

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

If they're not linked from anywhere, then they can't be found by crawlers.

aguschin added a commit to iterative/mlem that referenced this pull request Oct 27, 2022
@aguschin
Release 0.3.0 (#397)
663862f 
This is a list of activities that should be done before release announce

## First, things before release

### Breaking changes - merge in this PR
- [x] New deployment state management
- [x] New CLI interface: breaking changes in `serve`, `apply-remote`,
`build` and `declare`

### Other changes - merge in this PR
- [x] SageMaker deployments
- [x] K8s deployments
- [x] `--quiet` #448 @mike0sv 

### Docs
- [x] Finish semi-generated API reference PR
iterative/mlem.ai#172
- [x] Update Quick Start in this repo
- [x] iterative/mlem.ai#197
- [ ] iterative/mlem.ai#188

### Blog post
- [ ] blog post re release @aguschin 

### Example-repo - PR in `example-repos-dev`
- [x] update `example-mlem-get-started`

### Update the website code animations
- [x] https://mlem.ai

## Second, the release itself

### MLEM Release
- [ ] merge this branch
- [ ] release it on PyPi
- [ ] merge docs PR
- [ ] merge PR in `example-repos-dev` and update
`iterative/example-mlem-get-started`

## Third, things after release

- [ ] remove `xfail` mark from
`tests/cli/test_mail.py::test_commands_docs_links`
@aguschin aguschin mentioned this pull request Oct 27, 2022
Merged
@aguschin aguschin merged commit d2c5443 into release/0.3.0 Oct 27, 2022
@aguschin aguschin deleted the new-docs-structure branch October 27, 2022 16:53
jorgeorpinel
jorgeorpinel reviewed Oct 29, 2022
View reviewed changes
content/docs/get-started/serving.md
Comment on lines +34 to 35
While serving the model, you can open Swagger UI (OpenAPI) at
[http://localhost:8080/docs](http://localhost:8080/docs) to check out OpenAPI
Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

From #191 (comment):

localhost link should be in code. Idea is that right before that link you run mlem serve, that spins up a server there

Oh I see. Well, I don't think we need to make it an actual link, maybe just a code block you can copy easily?

If there is a way to disable the check for that specific link, please share that

I don't think so but you can check with @iterative/websites (or request the feature)

Copy link
Contributor

Choose a reason for hiding this comment

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

If it's for link checker CI, we can add the following line to https://github.com/iterative/mlem.ai/blob/main/config/link-check/excluded-links.yml

- 'http://localhost:8000**'

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @yathomasi, please see this PR #216

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: user-guide Content of /doc/user-guide C: ref Content of /doc/{command,api,object}-reference p1-important Active priorities to deal within next sprints C: get-started Content of /doc/get-started labels Oct 30, 2022
@aguschin aguschin mentioned this pull request Nov 7, 2022
Merged
@jorgeorpinel jorgeorpinel added the ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement label Dec 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@yathomasi yathomasi yathomasi left review comments

@madhur-tandon madhur-tandon madhur-tandon left review comments

@aguschin aguschin aguschin approved these changes

@shcheklein shcheklein shcheklein left review comments

@jorgeorpinel jorgeorpinel jorgeorpinel left review comments

Assignees

@mike0sv mike0sv

@aguschin aguschin

@madhur-tandon madhur-tandon

Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: get-started Content of /doc/get-started C: ref Content of /doc/{command,api,object}-reference C: user-guide Content of /doc/user-guide ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement p1-important Active priorities to deal within next sprints
Projects
No open projects
MLEM + GTO
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@mike0sv @aguschin @madhur-tandon @jorgeorpinel @shcheklein @yathomasi