Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Drop Conan 1.x from CCI documentation #25875

Merged
merged 23 commits into from
Nov 11, 2024

Conversation

uilianries
Copy link
Member

@uilianries uilianries commented Nov 7, 2024

Summary

Update documentation to follow Conan 2.x only

Motivation

With the update of CCI to run Conan 2.x only, the documentation became outdated.

This PR remove all outdated links and of the content that's well covered by the docs.conan.io. 🧹

It's even possible to simplify even more, pointing many topics directly to Conan Docs, but I would prefer doing it in a separated PR.

Details

  • Removed Hooks table with error description. The Conan Center hook no longer runs in CCI.
  • Replaced all docs.conan.io/1 links to Conan 2.x equivalent
  • Updated changelog with new CI date
  • Removed sections that are well covered by docs.conan.io already
  • Simplified access request section. Users only need CLA and they are "approved" via PR.
  • Removed Linters and Hook section as they are private for now
  • Updated Supported configurations file to follow the new CI
  • Removed Roadmap and Conan 2.x migration files. Finally working on Conan 2.x only
  • Removed Labels documentation as there is no automation over GH labels for now
  • Removed archived projects from Community Resources

Signed-off-by: Uilian Ries <uilianries@gmail.com>
@uilianries uilianries self-assigned this Nov 7, 2024
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
@uilianries
Copy link
Member Author

I checked all link that failed on the linter and they are fine. It's some permission limitation from the bot that's checking.

Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
* if some steps are sensitive to race conditions, monothread should be enforced.
* otherwise multithreaded build should be enabled with a number of cores controlled by `tools.build:jobs` conf from host profile if it is set, otherwise to all cores of build machine.

## Package Method
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### Build Requirements
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

conan center hooks is no longer running in CCI. This document does not reflect what is listed in Check results.

@@ -385,61 +357,6 @@ Keep reading in the [consuming recipes section](consuming_recipes.md#isolate-you
Version ranges are currently allowed on a handful of dependencies, but not for general use.
See [Dependencies Version Ranges](adding_packages/dependencies.md#version-ranges) for additional details.

## How to consume a graph of shared libraries?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the default in CCI

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mmm but possibly still needs pointing to -o "*:shared=True" as a blanket recommendation?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed by 8722871

docs/labels.md Outdated
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, the CI no uses labels to automate actions.

docs/linters.md Outdated
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous linters were removed and current one is maturating internally only.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Checks is very clear about what is supported. This document was updated by previous CI, but with several limitations.

README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
Signed-off-by: Uilian Ries <uilianries@gmail.com>
danimtb
danimtb previously approved these changes Nov 8, 2024
Copy link
Member

@danimtb danimtb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Less is more 🌈

@uilianries uilianries mentioned this pull request Nov 9, 2024
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
AbrilRBS
AbrilRBS previously approved these changes Nov 11, 2024
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
uilianries and others added 3 commits November 11, 2024 10:54
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
Co-authored-by: Abril Rincón Blanco <git@rinconblanco.es>
@uilianries uilianries requested review from jcar87 and danimtb November 11, 2024 10:02
@jcar87 jcar87 merged commit 919d894 into conan-io:master Nov 11, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants