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

Link to PDF-guides in dropdown #844

Merged
merged 1 commit into from
May 10, 2022
Merged

Link to PDF-guides in dropdown #844

merged 1 commit into from
May 10, 2022

Conversation

janhoy
Copy link
Contributor

@janhoy janhoy commented May 8, 2022

Add a link to PDF guides in the "old guides" section for completeness.

@janhoy janhoy requested a review from HoustonPutman May 8, 2022 22:02
@janhoy janhoy added the documentation Improvements or additions to documentation label May 8, 2022
Copy link
Contributor

@HoustonPutman HoustonPutman left a comment

Choose a reason for hiding this comment

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

So in reference to apache/solr-site#77, we might be able to keep this line now? (Since all versions will be in the drop-down)

Redirect 301 /guide/index.html /guide/solr/9_0/index.html

Seeing as the only reason for the /guide/index.html page is to list all of the versions, right? I think it's better to have the entry page the latest ref-guide welcoming page rather than the listing of all the versions.

Not something we have to decide now, but would be a good thing IMO.

@janhoy
Copy link
Contributor Author

janhoy commented May 9, 2022

So in reference to apache/solr-site#77, we might be able to keep this line now? (Since all versions will be in the drop-down)

I have thought the same thing. Sounds logical to end up with the start page of the latest guide when visiting /guide... Then we can remove that index page in solr-site.

However, if we anticipate other guides (such as solr-operator and perhaps solr-exporter?) to be added later, I wonder if /guide/solr/ would be a better "landing page" for the Ref Guide. Now, when you click the heading in top left corner of the guide, you are redirected to /guide, but if we also have /guide/operator/ then it makes more sense to let that text link to /guide/solr/.

Also, I discovered that the ref-guide places the JS, CSS etc in /guide/_/ which will totally break down if we add other antora sites alongside it?? Or will the "operator guide" be a module of the same Solr Ref guide, pulled from a different git repo?

@HoustonPutman
Copy link
Contributor

However, if we anticipate other guides (such as solr-operator and perhaps solr-exporter?) to be added later, I wonder if /guide/solr/ would be a better "landing page" for the Ref Guide. Now, when you click the heading in top left corner of the guide, you are redirected to /guide, but if we also have /guide/operator/ then it makes more sense to let that text link to /guide/solr/.

Yeah, we should definitely update the buttons to go to /guide/solr (and /guide/operator when that exists). I don't think it's a huge issue to make the "landing page" default to the solr guide when users go to solr.apache.org/guide. We can make the intro-page better and give information and link to the Solr Operator guide as well, so that users can easily find it if that's what they are looking for.

Also, I discovered that the ref-guide places the JS, CSS etc in /guide/_/ which will totally break down if we add other antora sites alongside it?? Or will the "operator guide" be a module of the same Solr Ref guide, pulled from a different git repo?

Yep, it will be a module of the same Solr Ref guide, pulled in from the solr-operator repo. Not sure exactly how the workflow will go, but it will be done as intended in antora.

@janhoy janhoy merged commit 8833b20 into apache:main May 10, 2022
@janhoy janhoy deleted the link-pdf-guide branch May 10, 2022 19:29
janhoy added a commit that referenced this pull request May 10, 2022
(cherry picked from commit 8833b20)
janhoy added a commit that referenced this pull request May 10, 2022
(cherry picked from commit 8833b20)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants