Skip to content

fix: remove edit block from reference documentation - #19

Open
msvticket wants to merge 9 commits into
mainfrom
remove-edit-from-generated
Open

fix: remove edit block from reference documentation#19
msvticket wants to merge 9 commits into
mainfrom
remove-edit-from-generated

Conversation

@msvticket

@msvticket msvticket commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Description

I'm removing the links to edit page hierarchies that are generated / imported from outside of jx-docs:

Following the documentation for docsy/hugo didn't work because we use such old versions.

So I updated hugo and docsy and on the way removed a lot our overrides to partials and replaced with the same functionality from docsy. I removed Google Tag manager with Google analytics since we don't have access to that anyway.

The functionality that was replaced with upstreams solutions are:

  • Dark / Light switch
  • Algolia search
  • Chroma syntax highlighting
  • Style edit page box
  • Mermaid

To get both the JayeX and CDFoundation logos in the top left I created an SVG combining them.

While at it I did a few small fixes I noticed while working

  • Changed where to create issues for feedback to the jx repo. I never enabled issues on jx-docs since the TOC has decided that we only want issues in the jx and lighthouse repos.

TODO

@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
The changes made require 1 more approval(s).
To complete the pull request process, please assign msvticket
You can assign the PR to them by writing /assign @msvticket in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@msvticket
msvticket force-pushed the remove-edit-from-generated branch 3 times, most recently from 662566d to 1e5cf2a Compare August 4, 2026 15:17
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

1 similar comment
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@msvticket
msvticket force-pushed the remove-edit-from-generated branch from 1e5cf2a to e6ee430 Compare August 4, 2026 15:30
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@msvticket
msvticket force-pushed the remove-edit-from-generated branch from 6e33d1d to 43f6a65 Compare August 4, 2026 17:09
@msvticket

Copy link
Copy Markdown
Contributor Author

/retest

@msvticket
msvticket force-pushed the remove-edit-from-generated branch 3 times, most recently from 235adb2 to 4a593dd Compare August 4, 2026 17:25
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@msvticket
msvticket force-pushed the remove-edit-from-generated branch from 4a593dd to d461ca3 Compare August 4, 2026 18:27
@msvticket
msvticket force-pushed the remove-edit-from-generated branch from d0ce3b4 to 0247792 Compare August 4, 2026 21:29
@msvticket

Copy link
Copy Markdown
Contributor Author

/retest

@msvticket
msvticket force-pushed the remove-edit-from-generated branch 2 times, most recently from 6dfa052 to d335880 Compare August 4, 2026 22:16
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

1 similar comment
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@msvticket
msvticket force-pushed the remove-edit-from-generated branch from 4a4bab8 to bebebc1 Compare August 4, 2026 22:41
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

revert to default theme functionality
join logos (while preserving link to cd.foundation work)
switch to official image
remove edit block from reference documentation
@msvticket
msvticket force-pushed the remove-edit-from-generated branch from bebebc1 to 155c488 Compare August 4, 2026 22:49
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

removing unused custom styling and code
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

doesn't work in firefox though
@jenkins-x-bot

Copy link
Copy Markdown
Collaborator

⭐ PR built and available in a preview jayex-io-jx-docs-pr-19 here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants