12:53 a.m.
Hi Sanne,
Thanks for your feedback. I was pretty sure I hadn't all the history!
Getting Google to prioritize our latest doc is probably a long time goal.
I played a bit with jQuery to suggest to the user to go to the latest
stable. Note that I only took into consideration the page for the time
being and didn't consider the anchor but it should be easy to add it
if we think it's worth it (it's a lot more work on the json descriptor
though).
The following command for each version is all that is needed:
sed -i 's@</body>@<script
src="http://code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script><script
src="/hibernate/search/outdated-version.js"></script></body>@'
*.html
(or a find -exec to do it on all the versions at once)
I attached the global json descriptor and the js file (with a .txt
extension as it didn't pass the mail filter). Both should be added to
/hibernate/search/. Note that I only did the work for version 4.5 in
the json descriptor. The work for other versions would mostly be a
copy/paste.
I also attached a screenshot of how it looks like. Nothing fancy but
we can do whatever we want.
Note that I only targeted the multi page HTML output as it was the
most interesting to prototype.
When we release a new version, we would have to update the descriptor file.
Comments?
--
Guillaume
On Tue, Jul 19, 2016 at 2:39 PM, Sanne Grinovero <sanne(a)hibernate.org> wrote:
Hi Guillaume,
yes I'm aware of the issue; we discussed it before, I think on this
same mailing list but maybe it was during our last meeting.
We really need to fix that metadata; Stefania (my partner) is an SEO
consultant and is shocked at how bad we do with this; apparently we
are a funny example in her office but at least we're not the worst :)
The problem is we can't change the headers as we don't control the
Apache httpd configuraion on the documentation server, so the
alternative is we'd need to rsync those docs locally, insert the right
changes in the static files of the docs, and push them back.
Needs a volunteer to find some time for this.
Also related to SEO I recently opened some issues on our WEBSITE
project, these should be easier to fix as it's directly under our
control:
- https://hibernate.atlassian.net/browse/WEBSITE-461
- https://hibernate.atlassian.net/browse/WEBSITE-460
- https://hibernate.atlassian.net/browse/WEBSITE-459
I've assigned them to Davide as he's usually quick with such things
but anyone is welcome to take some.
The metadata issue on the docs server is probably the most urgent /
valuable though.
Thanks,
Sanne
12:06 p.m.
New subject: People can't find our docs
I'll try to apply these changes on Friday.
Davide
On Tue, Jul 19, 2016 at 11:53 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
Hi Sanne,
Thanks for your feedback. I was pretty sure I hadn't all the history!
Getting Google to prioritize our latest doc is probably a long time goal.
I played a bit with jQuery to suggest to the user to go to the latest
stable. Note that I only took into consideration the page for the time
being and didn't consider the anchor but it should be easy to add it
if we think it's worth it (it's a lot more work on the json descriptor
though).
The following command for each version is all that is needed:
sed -i 's@</body>@<script
src="http://code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script><script
src="/hibernate/search/outdated-version.js"></script></body>@'
*.html
(or a find -exec to do it on all the versions at once)
I attached the global json descriptor and the js file (with a .txt
extension as it didn't pass the mail filter). Both should be added to
/hibernate/search/. Note that I only did the work for version 4.5 in
the json descriptor. The work for other versions would mostly be a
copy/paste.
I also attached a screenshot of how it looks like. Nothing fancy but
we can do whatever we want.
Note that I only targeted the multi page HTML output as it was the
most interesting to prototype.
When we release a new version, we would have to update the descriptor file.
Comments?
--
Guillaume
On Tue, Jul 19, 2016 at 2:39 PM, Sanne Grinovero <sanne(a)hibernate.org> wrote:
> Hi Guillaume,
>
> yes I'm aware of the issue; we discussed it before, I think on this
> same mailing list but maybe it was during our last meeting.
>
> We really need to fix that metadata; Stefania (my partner) is an SEO
> consultant and is shocked at how bad we do with this; apparently we
> are a funny example in her office but at least we're not the worst :)
>
> The problem is we can't change the headers as we don't control the
> Apache httpd configuraion on the documentation server, so the
> alternative is we'd need to rsync those docs locally, insert the right
> changes in the static files of the docs, and push them back.
>
> Needs a volunteer to find some time for this.
>
> Also related to SEO I recently opened some issues on our WEBSITE
> project, these should be easier to fix as it's directly under our
> control:
> - https://hibernate.atlassian.net/browse/WEBSITE-461
> - https://hibernate.atlassian.net/browse/WEBSITE-460
> - https://hibernate.atlassian.net/browse/WEBSITE-459
>
> I've assigned them to Davide as he's usually quick with such things
> but anyone is welcome to take some.
>
> The metadata issue on the docs server is probably the most urgent /
> valuable though.
>
> Thanks,
> Sanne
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
1:33 p.m.
New subject: People can't find our docs
Hi all!
So here is a status of what I did:
- I updated the /stable/ link of ogm from 3.0 (cough, cough) to 5.0:
http://docs.jboss.org/hibernate/stable/ogm/reference/en-US/html/: we
need to include this in our release process.
- I updated the /current/ symlink of ORM to point to 5.2 instead of
5.1: it needs to be integrated in the release process; (the /stable/
link uses the /current/ symlink so it's also fixed)
- I removed the docs for OGM 3.0 as they were a copy of the doc of OGM 4.2
Next, I applied some magic to 2 old versions of OGM and Search so that
you can check everything is OK for you before I generalize it:
- Add meta description and keywords
- Add a canonical link to the /stable/ single html version
- Add a piece of Javascript to warn the user and propose to redirect
him to the best possible place of our last stable release
documentation
See the 2 examples here:
http://docs.jboss.org.local/hibernate/ogm/4.1/reference/en-US/html/ogm-ar...
(scroll to see the hash tracker in action)
http://docs.jboss.org/hibernate/search/4.2/reference/en-US/html/search-ar...
See the current code and descriptors here:
https://docs.jboss.org/hibernate/_outdated-content/
The script and the descriptors work for all existing versions of the
OGM and Search doc.
The marker to include in the docs looks like that:
<script src="//code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script>
<script src="/hibernate/_outdated-content/outdated-content.js"
type="text/javascript"></script>
<script type="text/javascript">$(document).ready(function() {
HibernateDoc.OutdatedContent.install("search"); });</script>
(I'm using a CDN but maybe we should host jQuery on docs.jboss.org?)
The script is capable to redirect either to the multi page version
(using the redirects declared in the JSON file: it automatically
cumulates the redirects from version X to version Y so we don't need
that much metadata) or to the single page version by leveraging the
anchors and hashes. For now, I decided to push the user to the single
page version as it's the one we use for the canonical link but we can
of course discuss it. Note that I add a ?v=X.X parameter to be sure
the user is redirected to a fresh version of the corresponding
/stable/ page and not a cache. I had the issue a couple of times.
Next if you like it:
- generalize it to all the existing versions of the docs, sed FTW
- modify the Hibernate XSL stylesheets to include it in the newly generated ones
- probably modify our website so that the stable release points to the
/stable/ link to the docs
- do the same for Validator
@ORM: interested in me pursuing this for ORM too? It will probably be
a lot more work as the structure of the docs got changed a lot.
Comments, opinions, thoughts welcome.
--
Guillaume
On Wed, Jul 20, 2016 at 12:06 PM, Davide D'Alto <davide(a)hibernate.org> wrote:
I'll try to apply these changes on Friday.
Davide
On Tue, Jul 19, 2016 at 11:53 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
> Hi Sanne,
>
> Thanks for your feedback. I was pretty sure I hadn't all the history!
>
> Getting Google to prioritize our latest doc is probably a long time goal.
>
> I played a bit with jQuery to suggest to the user to go to the latest
> stable. Note that I only took into consideration the page for the time
> being and didn't consider the anchor but it should be easy to add it
> if we think it's worth it (it's a lot more work on the json descriptor
> though).
>
> The following command for each version is all that is needed:
> sed -i 's@</body>@<script
> src="http://code.jquery.com/jquery-3.1.0.min.js"
> integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
> crossorigin="anonymous"></script><script
>
src="/hibernate/search/outdated-version.js"></script></body>@'
*.html
> (or a find -exec to do it on all the versions at once)
>
> I attached the global json descriptor and the js file (with a .txt
> extension as it didn't pass the mail filter). Both should be added to
> /hibernate/search/. Note that I only did the work for version 4.5 in
> the json descriptor. The work for other versions would mostly be a
> copy/paste.
>
> I also attached a screenshot of how it looks like. Nothing fancy but
> we can do whatever we want.
>
> Note that I only targeted the multi page HTML output as it was the
> most interesting to prototype.
>
> When we release a new version, we would have to update the descriptor file.
>
> Comments?
>
> --
> Guillaume
1:34 p.m.
New subject: People can't find our docs
Iiiik, remove the .local suffix in the domain for the first example!
On Thu, Jul 21, 2016 at 1:33 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
Hi all!
So here is a status of what I did:
- I updated the /stable/ link of ogm from 3.0 (cough, cough) to 5.0:
http://docs.jboss.org/hibernate/stable/ogm/reference/en-US/html/: we
need to include this in our release process.
- I updated the /current/ symlink of ORM to point to 5.2 instead of
5.1: it needs to be integrated in the release process; (the /stable/
link uses the /current/ symlink so it's also fixed)
- I removed the docs for OGM 3.0 as they were a copy of the doc of OGM 4.2
Next, I applied some magic to 2 old versions of OGM and Search so that
you can check everything is OK for you before I generalize it:
- Add meta description and keywords
- Add a canonical link to the /stable/ single html version
- Add a piece of Javascript to warn the user and propose to redirect
him to the best possible place of our last stable release
documentation
See the 2 examples here:
http://docs.jboss.org.local/hibernate/ogm/4.1/reference/en-US/html/ogm-ar...
(scroll to see the hash tracker in action)
http://docs.jboss.org/hibernate/search/4.2/reference/en-US/html/search-ar...
See the current code and descriptors here:
https://docs.jboss.org/hibernate/_outdated-content/
The script and the descriptors work for all existing versions of the
OGM and Search doc.
The marker to include in the docs looks like that:
<script src="//code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script>
<script src="/hibernate/_outdated-content/outdated-content.js"
type="text/javascript"></script>
<script type="text/javascript">$(document).ready(function() {
HibernateDoc.OutdatedContent.install("search"); });</script>
(I'm using a CDN but maybe we should host jQuery on docs.jboss.org?)
The script is capable to redirect either to the multi page version
(using the redirects declared in the JSON file: it automatically
cumulates the redirects from version X to version Y so we don't need
that much metadata) or to the single page version by leveraging the
anchors and hashes. For now, I decided to push the user to the single
page version as it's the one we use for the canonical link but we can
of course discuss it. Note that I add a ?v=X.X parameter to be sure
the user is redirected to a fresh version of the corresponding
/stable/ page and not a cache. I had the issue a couple of times.
Next if you like it:
- generalize it to all the existing versions of the docs, sed FTW
- modify the Hibernate XSL stylesheets to include it in the newly generated ones
- probably modify our website so that the stable release points to the
/stable/ link to the docs
- do the same for Validator
@ORM: interested in me pursuing this for ORM too? It will probably be
a lot more work as the structure of the docs got changed a lot.
Comments, opinions, thoughts welcome.
--
Guillaume
On Wed, Jul 20, 2016 at 12:06 PM, Davide D'Alto <davide(a)hibernate.org> wrote:
> I'll try to apply these changes on Friday.
>
> Davide
>
> On Tue, Jul 19, 2016 at 11:53 PM, Guillaume Smet
> <guillaume.smet(a)gmail.com> wrote:
>> Hi Sanne,
>>
>> Thanks for your feedback. I was pretty sure I hadn't all the history!
>>
>> Getting Google to prioritize our latest doc is probably a long time goal.
>>
>> I played a bit with jQuery to suggest to the user to go to the latest
>> stable. Note that I only took into consideration the page for the time
>> being and didn't consider the anchor but it should be easy to add it
>> if we think it's worth it (it's a lot more work on the json descriptor
>> though).
>>
>> The following command for each version is all that is needed:
>> sed -i 's@</body>@<script
>> src="http://code.jquery.com/jquery-3.1.0.min.js"
>> integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
>> crossorigin="anonymous"></script><script
>>
src="/hibernate/search/outdated-version.js"></script></body>@'
*.html
>> (or a find -exec to do it on all the versions at once)
>>
>> I attached the global json descriptor and the js file (with a .txt
>> extension as it didn't pass the mail filter). Both should be added to
>> /hibernate/search/. Note that I only did the work for version 4.5 in
>> the json descriptor. The work for other versions would mostly be a
>> copy/paste.
>>
>> I also attached a screenshot of how it looks like. Nothing fancy but
>> we can do whatever we want.
>>
>> Note that I only targeted the multi page HTML output as it was the
>> most interesting to prototype.
>>
>> When we release a new version, we would have to update the descriptor file.
>>
>> Comments?
>>
>> --
>> Guillaume
2:07 p.m.
New subject: People can't find our docs
Nice,
Should we add a X or I got it button to remove this nagging when I have
to read and stay on the old doc?
If that piece of code is in the xsl, how will it work when the doc is in
the distribution?
How screwed are you if we stop using these stylesheet and say embrace
the Asciidoctor default style?
On Thu 2016-07-21 13:33, Guillaume Smet wrote:
Hi all!
So here is a status of what I did:
- I updated the /stable/ link of ogm from 3.0 (cough, cough) to 5.0:
http://docs.jboss.org/hibernate/stable/ogm/reference/en-US/html/: we
need to include this in our release process.
- I updated the /current/ symlink of ORM to point to 5.2 instead of
5.1: it needs to be integrated in the release process; (the /stable/
link uses the /current/ symlink so it's also fixed)
- I removed the docs for OGM 3.0 as they were a copy of the doc of OGM 4.2
Next, I applied some magic to 2 old versions of OGM and Search so that
you can check everything is OK for you before I generalize it:
- Add meta description and keywords
- Add a canonical link to the /stable/ single html version
- Add a piece of Javascript to warn the user and propose to redirect
him to the best possible place of our last stable release
documentation
See the 2 examples here:
http://docs.jboss.org.local/hibernate/ogm/4.1/reference/en-US/html/ogm-ar...
(scroll to see the hash tracker in action)
http://docs.jboss.org/hibernate/search/4.2/reference/en-US/html/search-ar...
See the current code and descriptors here:
https://docs.jboss.org/hibernate/_outdated-content/
The script and the descriptors work for all existing versions of the
OGM and Search doc.
The marker to include in the docs looks like that:
<script src="//code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script>
<script src="/hibernate/_outdated-content/outdated-content.js"
type="text/javascript"></script>
<script type="text/javascript">$(document).ready(function() {
HibernateDoc.OutdatedContent.install("search"); });</script>
(I'm using a CDN but maybe we should host jQuery on docs.jboss.org?)
The script is capable to redirect either to the multi page version
(using the redirects declared in the JSON file: it automatically
cumulates the redirects from version X to version Y so we don't need
that much metadata) or to the single page version by leveraging the
anchors and hashes. For now, I decided to push the user to the single
page version as it's the one we use for the canonical link but we can
of course discuss it. Note that I add a ?v=X.X parameter to be sure
the user is redirected to a fresh version of the corresponding
/stable/ page and not a cache. I had the issue a couple of times.
Next if you like it:
- generalize it to all the existing versions of the docs, sed FTW
- modify the Hibernate XSL stylesheets to include it in the newly generated ones
- probably modify our website so that the stable release points to the
/stable/ link to the docs
- do the same for Validator
@ORM: interested in me pursuing this for ORM too? It will probably be
a lot more work as the structure of the docs got changed a lot.
Comments, opinions, thoughts welcome.
--
Guillaume
On Wed, Jul 20, 2016 at 12:06 PM, Davide D'Alto <davide(a)hibernate.org> wrote:
> I'll try to apply these changes on Friday.
>
> Davide
>
> On Tue, Jul 19, 2016 at 11:53 PM, Guillaume Smet
> <guillaume.smet(a)gmail.com> wrote:
>> Hi Sanne,
>>
>> Thanks for your feedback. I was pretty sure I hadn't all the history!
>>
>> Getting Google to prioritize our latest doc is probably a long time goal.
>>
>> I played a bit with jQuery to suggest to the user to go to the latest
>> stable. Note that I only took into consideration the page for the time
>> being and didn't consider the anchor but it should be easy to add it
>> if we think it's worth it (it's a lot more work on the json descriptor
>> though).
>>
>> The following command for each version is all that is needed:
>> sed -i 's@</body>@<script
>> src="http://code.jquery.com/jquery-3.1.0.min.js"
>> integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
>> crossorigin="anonymous"></script><script
>>
src="/hibernate/search/outdated-version.js"></script></body>@'
*.html
>> (or a find -exec to do it on all the versions at once)
>>
>> I attached the global json descriptor and the js file (with a .txt
>> extension as it didn't pass the mail filter). Both should be added to
>> /hibernate/search/. Note that I only did the work for version 4.5 in
>> the json descriptor. The work for other versions would mostly be a
>> copy/paste.
>>
>> I also attached a screenshot of how it looks like. Nothing fancy but
>> we can do whatever we want.
>>
>> Note that I only targeted the multi page HTML output as it was the
>> most interesting to prototype.
>>
>> When we release a new version, we would have to update the descriptor file.
>>
>> Comments?
>>
>> --
>> Guillaume
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
2:20 p.m.
New subject: People can't find our docs
On Thu, Jul 21, 2016 at 2:07 PM, Emmanuel Bernard
<emmanuel(a)hibernate.org> wrote:
Should we add a X or I got it button to remove this nagging when I
have
to read and stay on the old doc?
I thought about it but I don't find it that invasive that we need to
add a close button. But I can do it if people think it's needed. I
suppose we would need a cookie to keep the information during the
navigation on the doc.
If that piece of code is in the xsl, how will it work when the doc is
in
the distribution?
It won't work. It won't be able to load the Javascript files (the //
doesn't work with file:// protocol, and
/hibernate/_outdated-content/outdated-content.js will not be present).
I can make it work by using absolute URLs for everything but I thought
it was better to not have it in the distribution doc: if you have
downloaded a particular version of the doc, you probably want to read
this version.
How screwed are you if we stop using these stylesheet and say
embrace
the Asciidoctor default style?
Well, either we can include top and bottom template anyway or we have
to run a sed on the files before uploading them to the doc server.
Maybe we should even do it this way and add the sed calls in our
release process. This way, it won't be in the distribution doc and we
won't have to alter the stylesheets.
Basically, we have to execute this in the reference directory (I
didn't do the work for the Javadoc, would it be useful?):
# Hibernate Search
find . -name \*.html -exec sed -i 's@</body>@<script
src="//code.jquery.com/jquery-3.1.0.min.js"
integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s="
crossorigin="anonymous"></script><script
src="/hibernate/_outdated-content/outdated-content.js"
type="text/javascript"></script><script
type="text/javascript">$(document).ready(function() {
HibernateDoc.OutdatedContent.install("search");
});</script></body>@'
{} \;
find . -name \*.html -exec sed -i 's@</title><link
rel="stylesheet"@</title><meta name="description"
content="Hibernate
Search, full text search for your entities - Reference Documentation"
/><meta name="keywords" content="hibernate, search, hibernate
search,
full text, lucene" /><meta name="viewport"
content="width=device-width, initial-scale=1.0" /><link
rel="canonical"
href="https://docs.jboss.org/hibernate/stable/search/reference/en-US...
/><link rel="stylesheet"@' {} \;
We might even include <!-- HibernateDoc.Outdated Content--> xxxx <!--
/HibernateDoc.OutdatedContent --> markers to be able to update the
code easily in the future. Same for the meta.
--
Guillaume
2:38 p.m.
New subject: People can't find our docs
On Thu 2016-07-21 14:20, Guillaume Smet wrote:
On Thu, Jul 21, 2016 at 2:07 PM, Emmanuel Bernard
<emmanuel(a)hibernate.org> wrote:
> Should we add a X or I got it button to remove this nagging when I have
> to read and stay on the old doc?
I thought about it but I don't find it that invasive that we need to
add a close button. But I can do it if people think it's needed. I
suppose we would need a cookie to keep the information during the
navigation on the doc.
> If that piece of code is in the xsl, how will it work when the doc is in
> the distribution?
It won't work. It won't be able to load the Javascript files (the //
doesn't work with file:// protocol, and
/hibernate/_outdated-content/outdated-content.js will not be present).
I can make it work by using absolute URLs for everything but I thought
it was better to not have it in the distribution doc: if you have
downloaded a particular version of the doc, you probably want to read
this version.
Right we should not have it.
2:46 p.m.
New subject: People can't find our docs
@Davide, @Sanne: would it be an issue to include the sed lines in our
release process to prepare the docs before uploading them to the doc
server?
If it's not, it's probably the best solution. I'll wait for your
confirmation before polishing them.
On Thu, Jul 21, 2016 at 2:38 PM, Emmanuel Bernard
<emmanuel(a)hibernate.org> wrote:
On Thu 2016-07-21 14:20, Guillaume Smet wrote:
> On Thu, Jul 21, 2016 at 2:07 PM, Emmanuel Bernard
> <emmanuel(a)hibernate.org> wrote:
> > Should we add a X or I got it button to remove this nagging when I have
> > to read and stay on the old doc?
>
> I thought about it but I don't find it that invasive that we need to
> add a close button. But I can do it if people think it's needed. I
> suppose we would need a cookie to keep the information during the
> navigation on the doc.
>
> > If that piece of code is in the xsl, how will it work when the doc is in
> > the distribution?
>
> It won't work. It won't be able to load the Javascript files (the //
> doesn't work with file:// protocol, and
> /hibernate/_outdated-content/outdated-content.js will not be present).
> I can make it work by using absolute URLs for everything but I thought
> it was better to not have it in the distribution doc: if you have
> downloaded a particular version of the doc, you probably want to read
> this version.
Right we should not have it.
2:52 p.m.
New subject: People can't find our docs
It should be easy for OGM, you need to update this file:
https://github.com/hibernate/hibernate-ogm/blob/master/src/main/release-s...
On Thu, Jul 21, 2016 at 1:46 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
@Davide, @Sanne: would it be an issue to include the sed lines in
our
release process to prepare the docs before uploading them to the doc
server?
If it's not, it's probably the best solution. I'll wait for your
confirmation before polishing them.
On Thu, Jul 21, 2016 at 2:38 PM, Emmanuel Bernard
<emmanuel(a)hibernate.org> wrote:
> On Thu 2016-07-21 14:20, Guillaume Smet wrote:
>> On Thu, Jul 21, 2016 at 2:07 PM, Emmanuel Bernard
>> <emmanuel(a)hibernate.org> wrote:
>> > Should we add a X or I got it button to remove this nagging when I have
>> > to read and stay on the old doc?
>>
>> I thought about it but I don't find it that invasive that we need to
>> add a close button. But I can do it if people think it's needed. I
>> suppose we would need a cookie to keep the information during the
>> navigation on the doc.
>>
>> > If that piece of code is in the xsl, how will it work when the doc is in
>> > the distribution?
>>
>> It won't work. It won't be able to load the Javascript files (the //
>> doesn't work with file:// protocol, and
>> /hibernate/_outdated-content/outdated-content.js will not be present).
>> I can make it work by using absolute URLs for everything but I thought
>> it was better to not have it in the distribution doc: if you have
>> downloaded a particular version of the doc, you probably want to read
>> this version.
>
> Right we should not have it.
>
3:06 p.m.
New subject: People can't find our docs
On 21 July 2016 at 13:52, Davide D'Alto <davide(a)hibernate.org> wrote:
It should be easy for OGM, you need to update this file:
https://github.com/hibernate/hibernate-ogm/blob/master/src/main/release-s...
+1, no problems for Search either. It's not scripted yet, so I'll just
need clear instructions on the release wiki:
- https://developer.jboss.org/wiki/ReleasingHibernateSearch
How should we update the metadata file at e.g.
http://docs.jboss.org/hibernate/_outdated-content/search.json ?
Maybe we could move that to the website, as similar metadata is
already being deployed, e.g.
- https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
Ideally the website building scripts could take the yaml file and
publish an updated search.json when updating hibernate.org ?
Looks great, thanks!
12:26 a.m.
New subject: People can't find our docs
On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero <sanne(a)hibernate.org> wrote:
Maybe we could move that to the website, as similar metadata is
already being deployed, e.g.
- https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
We already need to update the /stable/ symlink on the doc server so we
might as well do it when we push the doc.
I got something like this:
https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f . I'll
push a PR tomorrow.
I pushed the JS and the metadata to all known doc versions of Search and OGM.
--
Guillaume
5:57 p.m.
New subject: People can't find our docs
I've updated the microdata on our blog.
I used the google validation page to check the result:
https://search.google.com/structured-data/testing-tool/u/0/?hl=EN#url=htt...
I'm not familiar with microdata, if you think that something is wrong
let me know.
I have a question about the organization, should I put Red Hat or Hibernate?
At the moment I'm using Hibernate and hibernate.org as organizarion
url, but let me know.
Cheers,
Davide
On Thu, Jul 21, 2016 at 11:26 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero
<sanne(a)hibernate.org> wrote:
> Maybe we could move that to the website, as similar metadata is
> already being deployed, e.g.
> -
https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
We already need to update the /stable/ symlink on the doc server so we
might as well do it when we push the doc.
I got something like this:
https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f . I'll
push a PR tomorrow.
I pushed the JS and the metadata to all known doc versions of Search and OGM.
--
Guillaume
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
6:33 p.m.
New subject: People can't find our docs
Hibernate is fine.
On Fri 2016-07-22 16:57, Davide D'Alto wrote:
I've updated the microdata on our blog.
I used the google validation page to check the result:
https://search.google.com/structured-data/testing-tool/u/0/?hl=EN#url=htt...
I'm not familiar with microdata, if you think that something is wrong
let me know.
I have a question about the organization, should I put Red Hat or Hibernate?
At the moment I'm using Hibernate and hibernate.org as organizarion
url, but let me know.
Cheers,
Davide
On Thu, Jul 21, 2016 at 11:26 PM, Guillaume Smet
<guillaume.smet(a)gmail.com> wrote:
> On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero <sanne(a)hibernate.org> wrote:
>> Maybe we could move that to the website, as similar metadata is
>> already being deployed, e.g.
>> -
https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
>
> We already need to update the /stable/ symlink on the doc server so we
> might as well do it when we push the doc.
>
> I got something like this:
> https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f . I'll
> push a PR tomorrow.
>
> I pushed the JS and the metadata to all known doc versions of Search and OGM.
>
> --
> Guillaume
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
8:03 p.m.
New subject: People can't find our docs
The SEO expert liked the results :)
On 22 July 2016 at 17:33, Emmanuel Bernard <emmanuel(a)hibernate.org> wrote:
Hibernate is fine.
On Fri 2016-07-22 16:57, Davide D'Alto wrote:
> I've updated the microdata on our blog.
> I used the google validation page to check the result:
>
https://search.google.com/structured-data/testing-tool/u/0/?hl=EN#url=htt...
>
> I'm not familiar with microdata, if you think that something is wrong
> let me know.
>
> I have a question about the organization, should I put Red Hat or Hibernate?
> At the moment I'm using Hibernate and hibernate.org as organizarion
> url, but let me know.
>
> Cheers,
> Davide
>
> On Thu, Jul 21, 2016 at 11:26 PM, Guillaume Smet
> <guillaume.smet(a)gmail.com> wrote:
> > On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero <sanne(a)hibernate.org>
wrote:
> >> Maybe we could move that to the website, as similar metadata is
> >> already being deployed, e.g.
> >> -
https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
> >
> > We already need to update the /stable/ symlink on the doc server so we
> > might as well do it when we push the doc.
> >
> > I got something like this:
> > https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f . I'll
> > push a PR tomorrow.
> >
> > I pushed the JS and the metadata to all known doc versions of Search and OGM.
> >
> > --
> > Guillaume
> > _______________________________________________
> > hibernate-dev mailing list
> > hibernate-dev(a)lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/hibernate-dev
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
8:56 a.m.
New subject: People can't find our docs
Great :)
now I need to do the same with hibernate.org.
On Tue, Jul 26, 2016 at 7:03 PM, Sanne Grinovero <sanne(a)hibernate.org> wrote:
The SEO expert liked the results :)
On 22 July 2016 at 17:33, Emmanuel Bernard <emmanuel(a)hibernate.org> wrote:
> Hibernate is fine.
>
> On Fri 2016-07-22 16:57, Davide D'Alto wrote:
>> I've updated the microdata on our blog.
>> I used the google validation page to check the result:
>>
https://search.google.com/structured-data/testing-tool/u/0/?hl=EN#url=htt...
>>
>> I'm not familiar with microdata, if you think that something is wrong
>> let me know.
>>
>> I have a question about the organization, should I put Red Hat or Hibernate?
>> At the moment I'm using Hibernate and hibernate.org as organizarion
>> url, but let me know.
>>
>> Cheers,
>> Davide
>>
>> On Thu, Jul 21, 2016 at 11:26 PM, Guillaume Smet
>> <guillaume.smet(a)gmail.com> wrote:
>> > On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero <sanne(a)hibernate.org>
wrote:
>> >> Maybe we could move that to the website, as similar metadata is
>> >> already being deployed, e.g.
>> >> -
https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
>> >
>> > We already need to update the /stable/ symlink on the doc server so we
>> > might as well do it when we push the doc.
>> >
>> > I got something like this:
>> > https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f . I'll
>> > push a PR tomorrow.
>> >
>> > I pushed the JS and the metadata to all known doc versions of Search and
OGM.
>> >
>> > --
>> > Guillaume
>> > _______________________________________________
>> > hibernate-dev mailing list
>> > hibernate-dev(a)lists.jboss.org
>> > https://lists.jboss.org/mailman/listinfo/hibernate-dev
>> _______________________________________________
>> hibernate-dev mailing list
>> hibernate-dev(a)lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/hibernate-dev
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
9:09 a.m.
New subject: People can't find our docs
Great news!
On Wed, Jul 27, 2016 at 9:56 AM, Davide D'Alto <daltodavide(a)gmail.com>
wrote:
Great :)
now I need to do the same with hibernate.org.
On Tue, Jul 26, 2016 at 7:03 PM, Sanne Grinovero <sanne(a)hibernate.org>
wrote:
> The SEO expert liked the results :)
>
> On 22 July 2016 at 17:33, Emmanuel Bernard <emmanuel(a)hibernate.org>
wrote:
>> Hibernate is fine.
>>
>> On Fri 2016-07-22 16:57, Davide D'Alto wrote:
>>> I've updated the microdata on our blog.
>>> I used the google validation page to check the result:
>>>
https://search.google.com/structured-data/testing-tool/u/0/?hl=EN#url=htt...
>>>
>>> I'm not familiar with microdata, if you think that something is wrong
>>> let me know.
>>>
>>> I have a question about the organization, should I put Red Hat or
Hibernate?
>>> At the moment I'm using Hibernate and hibernate.org as organizarion
>>> url, but let me know.
>>>
>>> Cheers,
>>> Davide
>>>
>>> On Thu, Jul 21, 2016 at 11:26 PM, Guillaume Smet
>>> <guillaume.smet(a)gmail.com> wrote:
>>> > On Thu, Jul 21, 2016 at 3:06 PM, Sanne Grinovero <
sanne(a)hibernate.org> wrote:
>>> >> Maybe we could move that to the website, as similar metadata is
>>> >> already being deployed, e.g.
>>> >> -
https://github.com/hibernate/hibernate.org/tree/staging/_data/projects/se...
>>> >
>>> > We already need to update the /stable/ symlink on the doc server so
we
>>> > might as well do it when we push the doc.
>>> >
>>> > I got something like this:
>>> > https://gist.github.com/gsmet/8c8e29c46337f69bfbc9e84f108d951f .
I'll
>>> > push a PR tomorrow.
>>> >
>>> > I pushed the JS and the metadata to all known doc versions of Search
and OGM.
>>> >
>>> > --
>>> > Guillaume
>>> > _______________________________________________
>>> > hibernate-dev mailing list
>>> > hibernate-dev(a)lists.jboss.org
>>> > https://lists.jboss.org/mailman/listinfo/hibernate-dev
>>> _______________________________________________
>>> hibernate-dev mailing list
>>> hibernate-dev(a)lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>> _______________________________________________
>> hibernate-dev mailing list
>> hibernate-dev(a)lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/hibernate-dev
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
2:51 p.m.
New subject: People can't find our docs
On Thu, Jul 21, 2016 at 6:36 AM Guillaume Smet <guillaume.smet(a)gmail.com>
wrote:
@ORM: interested in me pursuing this for ORM too? It will probably be
a lot more work as the structure of the docs got changed a lot.
I would definitely be interested in a solution that finally allows us to
fix this. If you are willing to take this on, that would be amazing.
2830
days inactive
2838
days old
16 comments
7 participants
participants (7)
-
Davide D'Alto -
Davide D'Alto -
Emmanuel Bernard -
Guillaume Smet -
Sanne Grinovero -
Steve Ebersole -
Vlad Mihalcea