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

Api reference script #197

Merged
merged 5 commits into from
Oct 21, 2022
Merged

Api reference script #197

merged 5 commits into from
Oct 21, 2022

Conversation

aguschin
Copy link
Contributor

No description provided.

@shcheklein shcheklein temporarily deployed to mlem-ai-api-reference-s-kx1ba3 October 19, 2022 07:27 Inactive
@aguschin aguschin changed the base branch from main to new-docs-structure October 19, 2022 07:27
@github-actions
Copy link

github-actions bot commented Oct 19, 2022

8d95062

Link Check Report

13/153 links failed.

CML watermark

Verified

This commit was signed with the committer’s verified signature. The key has expired.
fao89 Fabricio Aguiar
@shcheklein shcheklein temporarily deployed to mlem-ai-api-reference-s-kx1ba3 October 19, 2022 10:59 Inactive
@aguschin
Copy link
Contributor Author

@mike0sv, I've updated scripts and re-generated API reference. Looks almost the same it was before, but now generated more automatically. Had to update docstrings in the code itself, this is the PR iterative/mlem#443

@aguschin aguschin requested a review from jorgeorpinel October 19, 2022 11:04
@aguschin
Copy link
Contributor Author

@jorgeorpinel, adding you to review in case you want to share feedback for this.

@aguschin aguschin requested a review from mike0sv October 19, 2022 11:04
@aguschin aguschin added C: ref Content of /doc/{command,api,object}-reference A: docs Area: user documentation (gatsby-theme-iterative) labels Oct 19, 2022
@shcheklein shcheklein temporarily deployed to mlem-ai-api-reference-s-kx1ba3 October 20, 2022 11:47 Inactive
@aguschin
Copy link
Contributor Author

OK, I'm merging this. Let's improve later.

@aguschin aguschin merged commit 98a6361 into new-docs-structure Oct 21, 2022
@aguschin aguschin deleted the api-reference-script branch October 21, 2022 05:54
@aguschin aguschin mentioned this pull request Oct 21, 2022
18 tasks
aguschin added a commit to iterative/mlem that referenced this pull request Oct 27, 2022
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`
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/{command,api,object}-reference
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants