conda-forge.github.io icon indicating copy to clipboard operation
conda-forge.github.io copied to clipboard

`conda-build` is not referenced at all in the docs

Open leofang opened this issue 3 years ago • 9 comments

I just realized that on the Conda-Forge documentation we do not refer to conda-build's documentation at all, which is very surprising. I am not sure if this is done on purpose, but when I started (and even after becoming an experienced feedstock maintainer) I had to refer to it more than often, because it is one of the pillars of Conda-Forge's infrastructure.

Over the time I found the following pages are the most useful ones:

  • https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html
  • https://docs.conda.io/projects/conda-build/en/latest/resources/activate-scripts.html
  • https://docs.conda.io/projects/conda-build/en/latest/resources/link-scripts.html
  • https://docs.conda.io/projects/conda-build/en/latest/user-guide/environment-variables.html

To the minimal extent, we should at least mention that this documentation exists so that advanced users/maintainers know where to look. Depending on the work scope, one may further consider incorporating some of the materials from there.

leofang avatar Apr 07 '21 02:04 leofang

cc @viniciusdc

leofang avatar Apr 07 '21 03:04 leofang

I would like to take this up!

PrernaSingh587 avatar Apr 07 '21 03:04 PrernaSingh587

For this particular task, I would suggest to coordinate with @viniciusdc, as the exact work scope needed to be done is unclear to me. It might turn out that most of the information there is already on CF's own doc pages (which would be great) and we just need to cherry-pick, or that there're historical reasons to not mention it (idk).

leofang avatar Apr 07 '21 03:04 leofang

@leofang Yeah sure. Would coordinate with @viniciusdc :)

PrernaSingh587 avatar Apr 07 '21 03:04 PrernaSingh587

I just realized that on the Conda-Forge documentation we do not refer to conda-build's documentation at all, which is very surprising. I am not sure if this is done on purpose, but when I started (and even after becoming an experienced feedstock maintainer) I had to refer to it more than often, because it is one of the pillars of Conda-Forge's infrastructure.

Over the time I found the following pages are the most useful ones:

  • https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html
  • https://docs.conda.io/projects/conda-build/en/latest/resources/activate-scripts.html
  • https://docs.conda.io/projects/conda-build/en/latest/resources/link-scripts.html
  • https://docs.conda.io/projects/conda-build/en/latest/user-guide/environment-variables.html

To the minimal extent, we should at least mention that this documentation exists so that advanced users/maintainers know where to look. Depending on the work scope, one may further consider incorporating some of the materials from there.

many thanks for opening this issue, was not at all aware of this conda-build documentation. Now can work on improving this too as well

prachinandi avatar Apr 07 '21 03:04 prachinandi

Hi! @leofang I am an outreachy applicant can I work on this issue Thanks

victory-lydia avatar Apr 08 '21 08:04 victory-lydia

Hi! @leofang I am an outreachy applicant can I work on this issue Thanks

HI @victory-lydia I started a gitter private dialog with you to give some directions, feel free to ping me there for anything

viniciusdc avatar Apr 08 '21 19:04 viniciusdc

Thanks

On Thu, Apr 8, 2021, 8:49 PM Vinicius D. Cerutti @.***> wrote:

Hi! @leofang https://github.com/leofang I am an outreachy applicant can I work on this issue Thanks

HI @victory-lydia https://github.com/victory-lydia I started a gitter private dialog with you to give some directions, feel free to ping me there for anything

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/conda-forge/conda-forge.github.io/issues/1335#issuecomment-816117963, or unsubscribe https://github.com/notifications/unsubscribe-auth/ATPJGTGYQLFA2HQ3Q3K734TTHYCFPANCNFSM42P4ST6Q .

victory-lydia avatar Apr 08 '21 19:04 victory-lydia

hi @leofang I am an outreachy applicant, can I work on this?

vanshmehra avatar Apr 08 '22 15:04 vanshmehra