Extract Windows build how-to from the Knowledge Base#2792
Extract Windows build how-to from the Knowledge Base#2792jaimergp merged 11 commits intoconda-forge:mainfrom
Conversation
✅ Deploy Preview for conda-forge-previews ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The link checker job is failing due to some network error. I think its unrelated to the changes I made here. |
| @@ -0,0 +1,258 @@ | |||
| --- | |||
| title: 'Particularities on Windows' | |||
There was a problem hiding this comment.
TBH, this doesn't sound like a particularly good title for a "how-to" :-). But unfortunately, I can't think of anything better immediately.
There was a problem hiding this comment.
I changed the title, to Build packages on Windows. Please let me know if it makes sense.
| <a id="particularities-on-windows"></a> | ||
|
|
||
| This document presents conda-forge and conda-build information and examples | ||
| while building on Windows. |
There was a problem hiding this comment.
| while building on Windows. | |
| related to building on Windows. |
| The first thing that you should know is that you can locally test Windows | ||
| builds of your packages even if you don't own a Windows machine. Microsoft | ||
| makes available free, official Windows virtual machines (VMs) [at this website](https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/). If you | ||
| are unfamiliar with VM systems or have trouble installing Microsoft's VMs, please | ||
| use a general web search to explore — while these topics are beyond the | ||
| scope of this documentation, there are ample discussions on them on the broader | ||
| Internet. |
There was a problem hiding this comment.
The link no longer works. Could you look around if it's still possible? If not, we should probably replace this with an appropriate note.
There was a problem hiding this comment.
I removed the link and mentioned that its Windows virtual machines is now free trial based. Leaving upon the users to find their source in order to download that free trial version is better IMO.
|
|
||
| The following feedstocks are examples of this build structure deployed: | ||
|
|
||
| - [libpng](https://github.com/conda-forge/libpng-feedstock/blob/main/recipe/build.bat) |
There was a problem hiding this comment.
This one's using Ninja now.
| - You can [free trial Windows VMs from Microsoft](https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/). | ||
| Set one up with your favorite virtualization solution to debug your CMD syntax. |
| --- | ||
| title: 'Build packages on Windows' | ||
| --- |
There was a problem hiding this comment.
| --- | |
| title: 'Build packages on Windows' | |
| --- | |
| # Build packages on Windows |
| <a id="executing-a-build"></a> | ||
|
|
There was a problem hiding this comment.
| <a id="executing-a-build"></a> |
| <a id="testing-a-local-build"></a> | ||
|
|
There was a problem hiding this comment.
| <a id="testing-a-local-build"></a> |
|
I didn't read the whole thing because I noticed that it may not be a good fit for the how-to format. It's very long, and it doesn't really have a concrete goal in mind. I do agree we need to move it from KB though. Maybe a Windows subdirectory with several smaller howto's? Also, please remove the redundant |
Makes sense to me. We can group similar sections and put it under Windows directory in a separate |
|
@jaimergp I addressed your reviews and also split the how-to for Windows into multiple items under "Building Packages For Windows". |
There was a problem hiding this comment.
I think there's a way to autogenerate these pages so we don't have to manually update this file. You can rename this file to windows.mdx (so it matches the directory) and then use this type of snippet:
https://github.com/conda-forge/conda-forge.github.io/blob/main/docs/how-to/basics.mdx?plain=1
There was a problem hiding this comment.
This one in particular feels more like an explanation at times to me, but it's also a how-to of sorts. No need to change anything, just saying that it's mixed media and maybe we will get back to it at some point.
|
The Also, @jaimergp I have addressed your latest round of reviews. |
| scope of this documentation, there are ample discussions on them on the broader | ||
| Internet. | ||
|
|
||
| To bootstrap a conda environment and install `conda-build`, consider |
There was a problem hiding this comment.
| To bootstrap a conda environment and install `conda-build`, consider | |
| To bootstrap a conda environment, consider |
| Because we're using `conda-build` directly instead of `build-locally.py`, | ||
| we can use the `local` channel: | ||
|
|
||
| ```default | ||
| conda create -n my-new-env -c local my-package | ||
| ``` |
There was a problem hiding this comment.
This is no longer correct (since we aren't using conda-build directly).
|
@mgorny I have addressed your reviews. |
| cd build | ||
|
|
||
| :: Configure using the CMakeFiles | ||
| cmake -G "NMake Makefiles" ^ |
There was a problem hiding this comment.
Don't we need to pass %CMAKE_ARGS% here?
There was a problem hiding this comment.
I think, %CMAKE_ARGS% already covers, -DCMAKE_INSTALL_PREFIX and -DCMAKE_PREFIX_PATH, so I removed those two flags and passed %CMAKE_ARGS% instead.
I hope this addresses your review.
mgorny
left a comment
mgorny
left a comment
There was a problem hiding this comment.
Just noticed we can update the highlighting here. Ofc, it's fine to leave it as-is and do as a followup.
- Add windows-builds.md as an index page linking to the three Windows-specific sub-guides - Improve page titles for cmd-batch-syntax, local-testing, and notes-on-native-code to be more descriptive - Update sidebar label from "Build on Windows" to "Building packages for Windows" and register only the index page - Update cross-references in infrastructure.mdx and knowledge_base.mdx to point to the new page paths and titles
Rename `how-to/advanced/windows-builds.md` to `windows.mdx` and use `DocCardList` to auto-generate the child page links, matching the pattern used by other index pages (e.g. `basics.mdx`). Update the sidebar and knowledge base cross-reference accordingly.
|
@jaimergp This is good to go if my review response seems ok to you. |
Co-authored-by: Michał Górny <mgorny@gentoo.org>
3 participants
PR Checklist:
docs/orcommunity/, you have added it to the sidebar in the corresponding_sidebar.jsonfileSummary
As part of the ongoing Diataxis restructuring of the conda-forge docs, this PR extracts the Windows-specific packaging content from the monolithic Knowledge Base page into a focused, standalone how-to guide.
Changes
docs/how-to/advanced/windows-builds.mdx: contains the full content of the following sections, moved verbatim fromknowledge_base.mdx:docs/maintainer/knowledge_base.mdx: the moved sections are replaced with a short redirect pointing to the new page (How-to > Advanced > Particularities on Windows), consistent with the pattern already used for the CMake how-to.Motivation
Addresses Quansight-Labs/conda-ecosystem-sta-mgmt#123
No content was modified. This is a pure move.