Diátaxis: cross-compilation #2686
Conversation
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Rather than deferring to an external source that doesn't really guarantee to be stable nor point clearly which answer is correct, let's just put a short explanation ourselves. On top of that, let's explain why it's largely irrelevant to our docs. Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
The text is switching between `build_platform` and `target_platform` to the point of making one dizzy. Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Update for some good practices, give dependency examples, make code more complete (i.e. don't skip middle steps). Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
While it makes sense to align them across examples, this one has an extra condition, so it's probably better to shift it left, so people have a better chance of noticing it. Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
✅ Deploy Preview for conda-forge-previews ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
|
I've experimentally also added tabs to switch between v0 and v1 recipes, though it would be nice to be able to express this in a more concise way. |
Signed-off-by: Michał Górny <[email protected]>
I like the result! If we end up using these a lot, we can also create a custom component as syntactic sugar. While I don't think we can save a lot of characters, it may be useful to at least add consistency to the tab titles and syntax highlighting? |
Signed-off-by: Michał Górny <[email protected]>
Indeed. I suppose https://docusaurus.io/docs/markdown-features/react is what I'm looking for — though no immediate idea for good semantics. Ideally we'd have some way of passing both blocks to it, but I don't think that's possible within that framework. Maybe https://docusaurus.io/docs/advanced/plugins could do it but that may be an overkill. Maybe something like: <RecipeTabs>
<RecipeV0>
...
</RecipeV0>
<RecipeV1>
...
</RecipeV1>
</RecipeTabs>would be good enough? |
|
Let me take a look locally, I think we can pass two children without component tags. |
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Rewrite the text to be less focused on internal variables, and more on the concepts. Update variable explanations to use `host_platform` for v1 recipes. Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
Signed-off-by: Michał Górny <[email protected]>
| - If it needs to be available on the target host, it goes in `host`. | ||
| - If both conditions are true, it belongs in both. | ||
|
|
||
| However, there are some exceptions to this rule; most notably [Python cross-compilation](#details-about-cross-compiled-python-packages). |
There was a problem hiding this comment.
Can you also note that python needs to be in host even if not cross-compiled because it hasn't historically supported cross-compilation?
There was a problem hiding this comment.
To be honest, I don't think that's the right place to say that. I mean, people who need to depend on Python while not cross-compiling aren't going to exactly look for where to place it in docs about cross-compiling.
Co-authored-by: Isuru Fernando <[email protected]>
3 participants
PR Checklist:
docs/orcommunity/, you have added it to the sidebar in the corresponding_sidebar.jsonfileThis is primarily moving the current docs from KB to a new how-to, and attempting to modernize/clean them up.
I think at least some of the Python bits belong in "understanding conda-forge" — though I suppose to integrate them we'd need to write some more general explanation of how cross works. Not sure how much detail we want to delve into.