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

Appendix pages are not showing up #325

Open
1 of 3 tasks
karenzone opened this issue Jan 22, 2025 · 4 comments
Open
1 of 3 tasks

Appendix pages are not showing up #325

karenzone opened this issue Jan 22, 2025 · 4 comments
Labels

Comments

@karenzone
Copy link

karenzone commented Jan 22, 2025

Describe the bug

Logstash uses an appendix to house deleted pages.
These pages are not indexed, but provide a place to land if a user has a link (from forums, user groups, etc). If we have alternatives to offer to a feature we've removed, we owe it to our users to let them know.

Note: After a quick search in the logstash.md source files, it looks like these pages might not have been output. Tagging as a possible migration-tooling issue.

Expected behavior

Keep the appendix with deleted pages, or find a way to preserve the user information experience using a different approach.
Here's an example from classic doc set: https://www.elastic.co/guide/en/logstash/current/plugins-filters-multiline.html

Steps to reproduce

  1. Build the logstash.md doc set
  2. Go to http://localhost:3000/releasenotes.html and you're at the end of the content set.

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@karenzone karenzone added the bug label Jan 22, 2025
@bmorelli25
Copy link
Member

I've always understood the appendix pages to be temporary pages that can be used to keep the docs build happy while we wait for redirects to be implemented.

You're not seeing appendix pages because we decided not to bring deleted pages into V3 and instead fully rely on redirects when content moves. I believe redirects provide a better user experience, as there is no middle-ground page that a user has to click through to get to the content they want to see.

@colleenmcginnis
Copy link

In the inventory, I've found quite a few Appendix pages that are "real" pages. Happy to share more specifics if that would be helpful.

@karenzone
Copy link
Author

Here's an example where we use the appendix to maintain live links when we can still offer users a path forward:
https://www.elastic.co/guide/en/logstash/master/logstash-modules.html

For example, ArcSight module users can check out the Common Event Format (CEF) integration. Azure module users can check out the Azure Logstash integration.

I like this approach because it gives our users a path forward and keeps them engaged with our products.

@bmorelli25
Copy link
Member

Is there any differentiation in the headings of deleted pages vs appendix pages? If not, the only feasible way to move this content over is to add it to the nav in the asciidoc books prior to migration.

@bmorelli25 bmorelli25 marked this as a duplicate of #314 Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants