cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sylvain Lebresne (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CASSANDRA-12533) Images not handled correctly on website
Date Wed, 31 Aug 2016 12:52:21 GMT

    [ https://issues.apache.org/jira/browse/CASSANDRA-12533?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15452156#comment-15452156
] 

Sylvain Lebresne commented on CASSANDRA-12533:
----------------------------------------------

I've pushed the changes (proper images, back to doc for 3.7 and proper styling for "hint").
The pubsub of the website seems to have disliked my commit again though, so I'll check with
infra to get it unstuck. I'll close this ticket once it's online.

bq. Should we just avoid deploying docs from branches that aren't released yet?

That would be my assumption. It's pretty confusing for users otherwise imo.

bq. If that's the case, what should we do for tickets like CASSANDRA-12449, which are just
general improvements and not really version-specific?

Good question. When we have updates to the doc to do, we could push a special '-doc' branch
and use that for any further change. Say, today, 3.7 being the last release, we'd create a
cassandra-3.7-doc from the cassandra-3.7 tag and push doc changes). And we can delete that
branch once 3.8 is out. Plus, we're supposed to release each month and I suspect important
(for minor improvements, we could just let them go online with the next release if we're lazy,
not a huge deal) "general improvements" might not happen all the time (after an initial period
of stability of the doc) so we won't even create said branch most of the time.

bq. Perhaps writing out some notes on what exactly Jekyll does with the current setup would
be good.

Sure. I suppose you saw the {{README}} file in the website sources wich has some initial notes?
I'll try to add a few more details on what does what, but if you have specific point you'd
like me to address/clarify, that'll help too.


> Images not handled correctly on website
> ---------------------------------------
>
>                 Key: CASSANDRA-12533
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-12533
>             Project: Cassandra
>          Issue Type: Bug
>          Components: Documentation and Website
>            Reporter: Tyler Hobbs
>            Assignee: Sylvain Lebresne
>
> In the new [IDE|http://cassandra.apache.org/doc/latest/development/ide.html] section
of the website, the images are not working.  In {{site/public}} in SVN, the new images aren't
anywhere to be found, so either the build process isn't transferring them correctly, or they're
being used incorrectly in the original Sphinx source.
> On a related note, the styling for the "Hint" section on that page is missing. That might
be intentional, I'm not sure.
> More generally, I'm curious as to why we're using both Jekyll and Sphinx and not just
Sphinx alone?  It's sort of hard to tell how to fix this issue with both tools in use.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message