Commit Graph

71 Commits

Author SHA1 Message Date
Chris Mc
073a9a9909 (#14491) Docs: split up reviewing into new file sections
* cleanup patches from #14377

* subfolder dont exist with new generators

* styling is not enforced

* move attribute to new home + fix FAQ spelling

* delete out date CMake docs from older generators

* move test package docs

* delete empty file :)

* fix links

* wording + remove duplicated sections

* improve mention of future work

* [docs] Regenerate tables of contents

Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>
2022-12-02 14:25:04 +01:00
Michael Keck
4a046c2695 (#14523) docs: update Intel URLs 2022-12-02 04:27:22 +01:00
Chris Mc
97b198659f (#14377) docs: update picking sources and unify with patching rules
* docs: combined patch policy with picking sources

* docs: zap duplicate and improve language + links

* docs: fix sentence structure

* docs: fix links

* [docs] Regenerate tables of contents

Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>

* docs: change heading level

* docs: picking a better link

* Apply suggestions from code review

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>
Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
2022-11-25 18:07:28 +01:00
Chris Mc
e70b881101 (#14211) docs: split some policies by the implicated method
* docs: split some policies by the implicated method

* fix broken link

* fix broken link

* Apply suggestions from code review

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
2022-11-21 18:45:43 +01:00
Jan Grieb
8c8640c175 (#14213) updated link in PR template
* updated link in PR template

really, am I the first one to come across this?

* more broken docs links
2022-11-16 22:25:56 +01:00
Chris Mc
edacf97622 (#13736) docs: Create a subfolder for "adding packages"
* docs: group files about "adding packages"

* fixing links

* fixing links

* rename file

* minor changes

* fix merge conflicts

* touch ups

* fix order

* fix links

* Clean up notes

* Update docs/error_knowledge_base.md

* Update docs/developing_recipes_locally.md

* merge conflicts

* Apply suggestions from code review
2022-11-15 08:06:29 +01:00
github-actions[bot]
ce97a71b1f (#13925) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-11-01 20:05:56 +01:00
Uilian Ries
a35c5c3851 (#13814) [docs] Document inactive users process
* Document inactiver users

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Move next to acces request

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Faqs points to access request section

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/how_to_add_packages.md

Co-authored-by: Daniel <danimanzaneque@gmail.com>

* Update docs/how_to_add_packages.md

Co-authored-by: Daniel <danimanzaneque@gmail.com>

Signed-off-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: Daniel <danimanzaneque@gmail.com>
2022-11-01 18:06:03 +01:00
github-actions[bot]
9cd892b03e (#13282) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-10-05 10:05:20 +02:00
Chris Mc
8e7a087477 (#13209) docs: explain why no pdb is useful
* docs: explain why no pdb is useful

This was Diego answer to me which made a lot of sense

* fix broken links

* Apply suggestions from code review

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

Co-authored-by: Jordan Williams <jordan@jwillikers.com>
2022-10-03 15:46:35 +02:00
ericLemanissier
ff31c5ccd6 (#13230) docs: fix broken links
* docs: fix broken links

* revert linters.md removals
2022-09-30 19:04:17 +02:00
github-actions[bot]
3f4ce2ebdf (#13051) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-09-22 10:45:03 +02:00
Chris Mc
383ed57332 (#12281) docs: capture our policy for the options shared and fPIC
* docs: capture our policy for the options `shared` and `fPIC`

This came as a question on Slack, thought it was worth writting down 

https://cpplang.slack.com/archives/C41CWV9HA/p1660683315599809

* move everything to packing policy

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

* Apply sse4s suggest

* Add original q to faq and link to new docs

* Apply suggestions from code review

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>

* Note `rm_safe`

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: Uilian Ries <uilianries@gmail.com>
2022-09-21 09:24:15 +02:00
github-actions[bot]
384b1a129f (#12955) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-09-20 15:45:56 +02:00
Uilian Ries
6098bb66e6 (#13028) [docs] Remove how to disable pylint
* Remove how to disable pylint

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* faq skipping linter

Signed-off-by: Uilian Ries <uilianries@gmail.com>

Signed-off-by: Uilian Ries <uilianries@gmail.com>
2022-09-20 13:26:17 +02:00
Javier G. Sogo
7cc71effda (#12905) [docs] config.yml file is mandatory
* [docs]  file is mandatory

* Be more specific about date format and timezone
2022-09-15 01:04:11 +02:00
github-actions[bot]
b9250494fb (#12873) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-09-14 12:37:14 +02:00
Chris Mc
3d6939e99e (#12704) docs: update documentation for handling recipe changes
* docs: make sure to link `enable_revisions` so it's more obvious

* docs: move instructions to one place....

* docs: use latest language around possible solutions

* Update consuming_recipes.md

* update link from FAQs

* update with another review 😄

* Update docs/consuming_recipes.md

Co-authored-by: James <james@conan.io>

Co-authored-by: James <james@conan.io>
2022-09-14 12:30:47 +02:00
Chris Mc
e2b7abf4bf (#12872) docs: how to alert consumers to problems
* docs: how to alter consumers to problems

* Update docs/faqs.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>

Co-authored-by: Uilian Ries <uilianries@gmail.com>
2022-09-09 09:26:03 +02:00
Chris Mc
304d808ff7 (#12687) docs: spelling and formatting 2022-08-30 14:04:33 +02:00
github-actions[bot]
8a20c3a0bc (#11778) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-07-18 17:02:49 +02:00
Chris Mc
dada12fef9 (#11720) docs: What to do when there is a custom license
* docs: what to do when there is a custom license

this came up in #11121 and I am trying to capture the information

* link hook rules to FAQ

* also put it in the faq

* relative link same as #10639

* Update reviewing.md
2022-07-18 13:42:31 +02:00
Javier G. Sogo
933b84843c (#11625) docs/faqs - wrong title level 2022-07-11 13:02:12 +02:00
Uilian Ries
93744ce737 (#11588) [docs] Why not build testing as a recipe option
* Document build testing

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

* Update docs/packaging_policy.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/packaging_policy.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
2022-07-08 21:22:04 +02:00
SSE4
9a76fd20e7 (#11214) - update FAQ about Python support
Signed-off-by: SSE4 <tomskside@gmail.com>
2022-06-16 19:44:51 +02:00
Uilian Ries
3086a41d87 (#10747) [docs] Add codeowners on FAQs
* Add codeowners file

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Case sensitive name

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Remove codeowners

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update .github/CODEOWNERS

Co-authored-by: ericLemanissier <ericLemanissier@users.noreply.github.com>

* Update .github/CODEOWNERS

Co-authored-by: Daniel <danimanzaneque@gmail.com>

* Update docs/faqs.md

Co-authored-by: Daniel <danimanzaneque@gmail.com>

* Remove codeowners

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* CODEOWNERS need new GH Action

Signed-off-by: Uilian Ries <uilianries@gmail.com>

Co-authored-by: ericLemanissier <ericLemanissier@users.noreply.github.com>
Co-authored-by: Daniel <danimanzaneque@gmail.com>
Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
2022-06-08 11:00:39 +02:00
Javier G. Sogo
610e1c80c3 (#10840) lockfiles: link issues in v1, add note around recommendation 2022-05-20 06:45:21 +02:00
Javier G. Sogo
10aad63663 (#10639) docs: use relative links 2022-05-08 15:45:07 +02:00
Javier G. Sogo
36f84d6682 (#10379) [docs] Policy: remove old package versions 2022-04-21 14:20:42 +02:00
Chris Mc
8ddc88fad6 (#9548) Clarify importance of options when protecting from recipe changes
* Clarify importance of options when protecting from recipe changes

* Apply suggestions from code review

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
Co-authored-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>
2022-03-21 13:44:15 +01:00
github-actions[bot]
b73b296e9e (#9550) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-03-01 06:08:21 +01:00
Javier G. Sogo
0e4eba716b (#9541) [docs] Remove italics, they break the autogenerated link in TOC 2022-02-28 17:49:12 +01:00
github-actions[bot]
6ed3bcacf0 (#9390) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2022-02-15 16:27:08 +01:00
Javier G. Sogo
47bf1a7c18 (#9300) [doc] Entries about settings and options (and shared libraries)
* [doc] Entries about settings and options (and shared libraries)

* remove leftover

* Apply suggestions from code review

Co-authored-by: Daniel <danimanzaneque@gmail.com>

* rewrite note about executables and debug settings

* Apply suggestions from code review

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

Co-authored-by: Daniel <danimanzaneque@gmail.com>
Co-authored-by: Chris Mc <prince.chrismc@gmail.com>
2022-02-15 05:26:11 +01:00
Chris Mc
129b634cbc (#9140) [docs] Better description for why version ranges are not allowed
* [docs] Better describe why version ranges are not allowed

Follow up from the comments in the original PR so they are not lost

plus fixed a typo

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
2022-02-07 08:45:45 +01:00
Chris Mc
fec8640607 (#8831) [docs] Why are version rangers not allowed?
* Why are version rangers not allowed

* fix up some typos I noticed while scrolling

* Apply suggestions from code review

Co-authored-by: Uilian Ries <uilianries@gmail.com>

* Apply suggestions from code review

Co-authored-by: Uilian Ries <uilianries@gmail.com>

Co-authored-by: Uilian Ries <uilianries@gmail.com>
2022-01-28 20:36:47 +01:00
github-actions[bot]
75efc5473c (#8514) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2021-12-23 20:36:38 +01:00
Javier G. Sogo
afbed0c5b9 (#8488) [docs] Add a note about consuming recipes 2021-12-23 12:34:59 +01:00
toge
60a01cb145 (#7680) [doc] fix sample code in deprecated options in FAQ 2021-10-14 16:05:19 +02:00
github-actions[bot]
6d73edabca (#7570) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2021-10-06 21:33:11 +02:00
SSE4
a46a44757d (#7477) - add a clarification about Intel MKL, IPP, DNN
* - add a clarification about Intel MKL, IPP, DNN

Signed-off-by: SSE4 <tomskside@gmail.com>

* Update docs/faqs.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update docs/faqs.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update docs/faqs.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update docs/faqs.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

* Update docs/faqs.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update faqs.md

Co-authored-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
Co-authored-by: Chris Mc <prince.chrismc@gmail.com>
2021-10-06 18:33:04 +02:00
Uilian Ries
ff89a3079a (#7298) FAQ and Reviewing - Removing old project versions
* FAQ - Removing old versions

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Reviewing - Older versions

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Tweaks to wording in reviewing.md

* Tweaks to formatting in reviewing.md

* Tweaks to wording in faqs.md

Also divided up long paragraph for readability.

* Update docs/faqs.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update docs/faqs.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

Co-authored-by: Clare Macrae <github@cfmacrae.fastmail.co.uk>
Co-authored-by: Chris Mc <prince.chrismc@gmail.com>
Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
2021-09-22 00:32:11 +02:00
Chris Mc
f1d3af971e (#7301) docs: Improve system package FAQs and how to
* Update how_to_add_packages.md

* try to remove the duplication

* add missing documents

* use improved `conan create` syntax

* Update how_to_add_packages.md

https://github.com/conan-io/docs/pull/2212/files
2021-09-17 11:02:32 +02:00
github-actions[bot]
058c4bec73 (#7271) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2021-09-13 19:32:37 +02:00
Uilian Ries
c0d86ab7c4 (#6919) [docs] How to add system packages
* How to add system packages

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update GTK branch

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Replace GTK by OpenCL

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

* Update docs/how_to_add_packages.md
2021-09-13 09:31:47 +02:00
github-actions[bot]
9b1cbbb86e (#7250) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2021-09-13 00:32:10 +02:00
SSE4
6b83105a55 (#7227) - FAQ about python versions
* - FAQ about python versions

Signed-off-by: SSE4 <tomskside@gmail.com>

* Update docs/faqs.md

* Update docs/faqs.md

* Update docs/faqs.md

Co-authored-by: Michael Keck <git@cr0ydon.com>

Co-authored-by: Michael Keck <git@cr0ydon.com>
2021-09-11 17:32:34 +02:00
github-actions[bot]
b98aef19ec (#7183) [docs] Regenerate tables of contents
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
2021-09-06 17:32:20 +02:00
Chris Mc
32fb1e8b17 (#7169) docs: why are tests excluded from recipes
we had a very nice discussion under https://github.com/conan-io/conan-center-index/pull/5405 and I wanted to save it for next time it comes up
2021-09-06 17:02:13 +02:00
Chris Mc
10d383fc84 (#5719) Document policy for adding older package versions
* Document policy for adding older package versions

* Update docs/faqs.md

Co-authored-by: SSE4 <tomskside@gmail.com>

* Update docs/faqs.md

Co-authored-by: SSE4 <tomskside@gmail.com>
2021-06-04 18:01:36 +02:00