Conan-center-index: [service] Generate Wiki according docs changes

Created on 27 Jul 2020  路  7Comments  路  Source: conan-io/conan-center-index

Now both docs/ and Wiki are duplicated, we could put both in the Thunderdome, or just remove the Wiki.

UPDATE: @Croydon suggestion sounds more better, we can keep both.

Docs

Most helpful comment

that we use docs/ as the only source of truth and use CI to push its content to the GitHub wiki

I-Am-Once-Again-Asking-For

Agreed! But of course, it requires internal work. I gonna update my description and title. Thanks for the idea @Croydon !

All 7 comments

I don't think we should remove it. getting 404s would be annoying. you know people may visit wiki from google searches or from existing references from various blogs, twits, etc.
probably, existing pages should redirect to the new docs. if redirection is not possible, probably it should include some text and link to the corresponding section within new docs.

Indeed! Redirect is not possible, but we can add the links from docs.

First, we have to change the link from the KBs of the hook and point them to the docs folder, then we can put a link in every page of the wiki to redirect people there

I would like to suggest once more, that we use docs/ as the only source of truth and use CI to push its content to the GitHub wiki

GitHub's file preview isn't as nice as a wiki page when it comes to readability and GitHub's file listing isn't a real navigation either

that we use docs/ as the only source of truth and use CI to push its content to the GitHub wiki

I-Am-Once-Again-Asking-For

Agreed! But of course, it requires internal work. I gonna update my description and title. Thanks for the idea @Croydon !

The plan is as follows:

  1. Remove content from the wiki and substitute with a link to the docs
  2. When GA, remove/close the wiki in Github
  3. In the future, docs can be generated and published as a web page

Done.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

GordonJess picture GordonJess  路  3Comments

Croydon picture Croydon  路  3Comments

IceflowRE picture IceflowRE  路  3Comments

prince-chrismc picture prince-chrismc  路  3Comments

Croydon picture Croydon  路  3Comments