This updates the Project Mu documentation to reflect the new branching
and downstream consumption strategy.
---------
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Co-authored-by: Michael Kubacki <michael.kubacki@microsoft.com>
We presented Enhanced Memory Protection at the 2023 UEFI Plugfest. This
PR adds a section to our Project Mu docs on the requirements for
enhanced protection and compatibility mode which will serve as the
central location for this information.
Updates the license for the documentation to be BSD-2-Clause-Patent
instead of BSD 2-Clause for consistency with /License.txt and most
of the content in Project Mu repositories.
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Add a link to the rust install steps section of the rust_build.md
document to the prerequisites.md document so that it obvious to readers
that they must also install the rust requirements.
---------
Signed-off-by: Joey Vagedes <joey.vagedes@gmail.com>
Co-authored-by: Michael Kubacki <michael.kubacki@microsoft.com>
- Moves Rust build and documentation pages to `CodeDevelopment` so
it can be made available in that nav menu item.
- Adds the items to the nav menu to remove mkdocs warning and make
the documents easier to find.
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Adds documents that explain:
- How to build with Rust in Project Mu
- Documentation conventions for Rust code in Project Mu
- Motivation to adopt Rust in Project Mu
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Edk2-Pytools has transitioned to published docs, so this updates the
links referencing Edk2-Pytools to point at the docs rather than the
github markdown files.
Request issues be filed in the corresponding Project Mu repository.
Request general discussions be started in the Discussions section of
the relevant Project Mu repository.
Direct other discussions to the Discussions section of this repository.
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Though there's a preference to avoid specifying exact versions where
possible. In the case of tool chain tag examples, tags with exact
versions
are retained to provide a working example.
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Correct path for script to activate a python virtual environment.
Code snippet showing how to install the python requirements for a repository is referencing the file as it was originally named (requirements.txt). Now in most Project Mu and Edk2 repos the file is named pip-requirements.txt. Update sample to reflect that.
* Add support for pymarkdown extension tabbed content
* Add support for Mermaid graphs in markdown
* Update emoji support to use SVG and add material supported emojis
* Update code development docs to suggest using python virtual environments.
Add details of how to setup a virtual environment for a workspace
Add details of how to activate a virtual environment for each session.
* Add brief comment for Omnicache
Take a stab at a first draft of the release process including: branching, tagging, naming conventions, and lifecycle. This may be revised as we learn how the process works with the larger community.
* Add Badge to top of README
* Improve README 'about'
* Add 'How to build' section to README
* Update docs on website
* Update Pipeline to use requirements.txt
* Fix double installation of mkdocs
* Drop 'the'
* Fix mkdocs command
Oliver Smith-Denny
Taylor Beebe
RaymondY
Michael Kubacki
Joey Vagedes
Taylor Beebe
Gary Beihl
Bret Barkelew
MC-Long
Bret Barkelew
Bret Barkelew
Sean Brogan
Seth Grossman
Jeremiah Cox
Max Knutsen
Misdre
Sean Brogan
Stefan M
Gaurav Sachdeva
abhiraj963
Manank Patni
Uzer Jamal