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

move content that was built from checkstyle-8.8 tag into 8.8/ sub-folder #2

Closed
wants to merge 2 commits into from

Conversation

vorburger
Copy link

No description provided.

@vorburger
Copy link
Author

@romani @daniilyar in order to be able to keep several version of the CS doc site on http://checkstyle.org, I suggest to use per-version sub-directories instead of having the content at root.

This PR 2nd commit also proposes a minimalistic root index.html with a redirect header to current version.

@rnveach
Copy link

rnveach commented Mar 27, 2018

do we really need a versioned directory for the web pages?
Oracle does it for their javadocs and whenever you search on a class in google, it usually always returns the oldest version (Java 6 for example). Then to look at the latest, you need to find the current release version and swap out the old number for the new in the URL. This usually works as long as the directory/file names didn't change any.
If people are always sent to old documents on google, it could cause some issues (false reports, etc...).

@romani
Copy link
Member

romani commented Mar 27, 2018

I am not ok, all links to latest doc should be as non redirected.

I think it is good to have several old web sites, so they should be checkstyle/X.X/..... probably but how we will tell google index robots to make main pages to be top ranked.

@vorburger , it is better to make issue and discuss and got approval for your steps before implementation. There are bunch of us here we need to come to same resolution on such big questions.

Copy link
Member

@romani romani left a comment

Choose a reason for hiding this comment

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

see comment above

@vorburger
Copy link
Author

see comment above

@romani @rnveach I'm trying to understand if I should Abandon this or what specific changes to this PR you are requesting to merge it...

I am not ok, all links to latest doc should be as non redirected.

so remove the 2nd commit which adds root index.html with redirect to version

how we will tell google index robots to make main pages to be top ranked

I doubt you really can. However one idea could be have a /latest/ ln -s symlink. I've tested this on another Git Hub pages (personal home page) and apparently this seems to work. Would you like this PR to be amended with that? And have a redirect to that /latest/ in the root index.html instead of to 8.8/ ?

better to make issue and discuss and got approval for your steps before implementation

No no, this is open source, we work together, it's not someone "approving" something of someone else... It's actually great to propose something concrete and then discuss feedback against it in comments of a PR... 😃

@romani
Copy link
Member

romani commented Apr 3, 2018

No no, this is open source, we work together, it's not someone "approving" something of someone else..

Tell me a bout this :) .
Open source has more rules than even proprietary code. Nothing is done on desire of one individual. Even between maintainers were are disagreements, but in cases we result in constructive discussion and agreements. "we work together" .... so please open the issue and lets got approval from all/most participants.

so remove the 2nd commit which adds root index.html with redirect to version

Right now, I do not like sub folders. We even did not migrate to new location as-is and you discuss next stage problem to let users see previous versions documentation.
I appreciate your desire to help, but lets do all steps by step.

@vorburger
Copy link
Author

OK no problem - closing to abandon this.

@vorburger vorburger closed this Apr 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants