Skip to content

Conversation

@kcbimonte
Copy link

@kcbimonte kcbimonte commented Oct 25, 2025

BLUF

As a Concourse Contributor, I want to modernize the Concourse docs using MkDocs, so that I can lower the barrier of entry for contributing new information.

Task List

Current task list:

  • Move all existing files to .old
  • Create skeletons for all pages
  • Create redirects for all pages
  • Transfer all docs information over
  • Transfer all blog information over
  • Determine how to display schemas
  • Determine how to create homepage
  • Update CI to support mkdocs (could use mkdocs gh-deploy --force) for ease of use

@kcbimonte kcbimonte force-pushed the docs-rewrite branch 2 times, most recently from 9f3c0de to 558af59 Compare October 26, 2025 12:33
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 27, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@kcbimonte kcbimonte force-pushed the docs-rewrite branch 2 times, most recently from e6ed22b to 70bd557 Compare October 27, 2025 18:41
@taylorsilva
Copy link
Member

This just came across my feed: https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/

Some interesting tidbits:

  • Mkdocs is unmaintained (?). Last release is August 2024 and master branch has received very few commits. I did not notice this before.
  • Material for MkDocs is now in maintenance mode and the team behind it started zensical as a successor to mkdocs

I don't think we should try switching to their thing now. I think making this jump, booklit to Mkdocs, is a good first step. Then we can possibly look at moving over to Zensical. They mention they're putting significant effort into the mkdocs -> zensical migration path.

@kcbimonte
Copy link
Author

kcbimonte commented Nov 5, 2025

Yup, just saw that as well and was going to suggest a slight pause on this to see how this whole Zensical thing played out before going any further.

taylorsilva and others added 21 commits November 11, 2025 15:20
add pixel air to ecosystem page

add link to Taylor's GH profile for project finance matters

Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Related to https://github.com/orgs/concourse/discussions/6402

Signed-off-by: Taylor Silva <dev@taydev.net>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
NOTE: Lots of old issue links that may not be valid anymore
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
kcbimonte and others added 10 commits November 11, 2025 15:24
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Signed-off-by: Mathias Bogaert <mathias.bogaert@gmail.com>
Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
# Conflicts:
#	html/banner.tmpl
@kcbimonte
Copy link
Author

Determined how to do CI I believe. This will also clear out a bunch of junk from the gh-pages branch that shouldn't be there but is navigable:

Signed-off-by: Kevin Bimonte <kbimonte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants