Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

Documentation updates for v0.5.0 #324

Merged
merged 16 commits into from
Aug 13, 2019
Merged

Conversation

twelho
Copy link
Contributor

@twelho twelho commented Aug 12, 2019

This PR contains a collection of documentation updates/enhancements for v0.5.0.
Fixes #312.

cc @luxas

@twelho twelho added documentation/improvement Improve something in the docs documentation/out-of-date Address that some docs are out of date kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/wip The PR is still work in progress labels Aug 12, 2019
@twelho twelho added this to the v0.5.0 milestone Aug 12, 2019
cpus: 2
diskSize: 3GB
memory: 800MB
```

This API object specifies a need for 2 vCPUs, 800MB of RAM and 3GB of disk.
This API object specifies a need for 2 vCPUs, 800 MB of RAM and 3 GB of disks space.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: disk space

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks

|-------|------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Intel | x86_64 | Complete | Requires <a href="https://en.wikipedia.org/wiki/X86_virtualization#Intel_virtualization_(VT-x)">VT-x</a>, most non-Atom 64-bit Intel CPUs since Pentium 4 should be supported |
| AMD | x86_64 | Alpha | Requires [AMD-V](https://en.wikipedia.org/wiki/X86_virtualization#AMD_virtualization_.28AMD-V.29), most AMD CPUs since the Athlon 64 "Orleans" should be supported |
| ARM | AArch64 (64-bit) | Alpha | Requires GICv3, see [here](https://github.com/firecracker-microvm/firecracker/issues/1196) |
Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome, thanks for pointing this out 👍

<component name="Go" enabled="true" />
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Python 3.7 interpreter library" level="application" />
Copy link
Contributor

Choose a reason for hiding this comment

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

?
can we just drop this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we decide to drop IDE-specific configuration, I'll do it in a separate PR

@twelho
Copy link
Contributor Author

twelho commented Aug 13, 2019

This should be all of the docs, removing do-not-merge label

@twelho twelho removed the do-not-merge/wip The PR is still work in progress label Aug 13, 2019
Copy link
Contributor

@luxas luxas left a comment

Choose a reason for hiding this comment

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

Thank you a lot for this PR!
LGTM 👍

@luxas luxas merged commit 6cf3602 into weaveworks:master Aug 13, 2019
@twelho twelho deleted the doc-updates branch August 29, 2020 09:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation/improvement Improve something in the docs documentation/out-of-date Address that some docs are out of date kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reflect API changes in documentation for v0.5.0
2 participants