rustdoc all-features about kellnr HOT 8 CLOSED

Enabled in latest release.

from kellnr.

Hi @snaggen, thank you for reporting that. Yes, a.t.m only the default feature is build. I'll keep this as the first feature request for kellnr.

from kellnr.

I'm excited to see kellnr come to life, and also see it including docs :)

My 2c about this:
I believe that over time, the doc-build will at least partially have to replicate docs.rs functionality.

Probably incomplete examples, from the top of my head, would include:

• this request here (docs.rs metadata),
• crates-build-env for needed c-libraries for your dependencies.
• build inside a countainer (probably with rustwide for security (while you probably don't have to care about the source / build-script for your own private packages, you are executing build.rs files locally for each dependency they include, which might leak the private source code of your own packages).

My recommendation would be to "librarify" the needed parts of the docs.rs codebase, and use these here in kellnr. Alternatively perhaps run actual docs.rs next to kellnr.

I'm happy to review / discuss any PR to librarify docs.rs, or help with self-hosting (it's not fully documented yet).

( for reference: I'm part of the docs.rs team )

from kellnr.

Hi @syphar,

when I build the doc.rs hosting in Kellnr I wanted the most simple solution that works out of the box. For the future, a more sophisticated approach is needed and I don't intend to re-invent the wheel. Using parts of docs.rs in Kellnr would be super cool and keep the docs ecosystem from fragmentation.

If you are interested, a docs.rs + kellnr joint venture would be awesome :)

from kellnr.

when I build the doc.rs hosting in Kellnr I wanted the most simple solution that works out of the box. For the future, a more sophisticated approach is needed and I don't intend to re-invent the wheel. Using parts of docs.rs in Kellnr would be super cool and keep the docs ecosystem from fragmentation.

This sounds like a good plan. But keep in mind: there are security implications of the current implementation. As a company, I would want to know this before using kellnr.

If you are interested, a docs.rs + kellnr joint venture would be awesome :)

As many projects we have limited capacity, so our topics are different ones right now. But as described, I'm happy to discuss any design / ideas, and review PRs 😃 .

from kellnr.

There is already a big disclaimer in the docs that building docs is basically arbitrary code execution like on any build server.

I would go with multiple steps to incorporate parts from docs.rs.

1. Replace the raw "rustdoc" call from Kellnr with a library from docs.rs which handles different features and configs for docs.rs
2. Allow Kellnr to switch from a local Rust install to the usage of Docker or something more secure
3. Allow custom build steps (not sure if that is needed), e.g. install native libraries or something else that is not handled by a simple "rustdoc" call

What do you think about that? The first step should be straight forward, if you can provide a library which takes the docs.rs specific config from the Cargo.toml and builds the docs.

from kellnr.

There is already a big disclaimer in the docs that building docs is basically arbitrary code execution like on any build server.

I missed that one, sorry about that.

I would go with multiple steps to incorporate parts from docs.rs.

1. Replace the raw "rustdoc" call from Kellnr with a library from docs.rs which handles different features and configs for docs.rs

2. Allow Kellnr to switch from a local Rust install to the usage of Docker or something more secure

sounds good

3. Allow custom build steps (not sure if that is needed), e.g. install native libraries or something else that is not handled by a simple "rustdoc" call

The docs.rs strategy for this will be rust-lang/docs.rs#315 (the crate can provide a custom docker image to build with).

What do you think about that? The first step should be straight forward, if you can provide a library which takes the docs.rs specific config from the Cargo.toml and builds the docs.

I'm happy to review any PR to docs.rs that does this, or answer any questions.

from kellnr.

I wonder if it would be possible to maybe default to 'all-features' (or add a flag for it) in the short term, since the larger rustdoc rewrite sounds lika a larger thing.

from kellnr.