You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Grant Ingersoll (Created) (JIRA)" <ji...@apache.org> on 2012/02/04 22:51:53 UTC
[jira] [Created] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Convert Versioned docs to Markdown/New CMS
------------------------------------------
Key: LUCENE-3750
URL: https://issues.apache.org/jira/browse/LUCENE-3750
Project: Lucene - Java
Issue Type: Improvement
Reporter: Grant Ingersoll
Priority: Minor
Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Mark Miller (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13209794#comment-13209794 ]
Mark Miller commented on LUCENE-3750:
-------------------------------------
I'm in a similar boat with site updates at the moment - while I struggled through the setup in the past, I had things working smoothly at one point - but since I've updated recently, I can no longer build the site - i get two errors about the JIRA additions in the sidebar.
{noformat}
. at /Users/markrmiller/Workspaces/lucid/cms/lib/view.pm line 46
File content/solr/index.mdtext had processing errors: Error while rendering output to string
get http://s.apache.org/solrjira failed.
. at /Users/markrmiller/Workspaces/lucid/cms/lib/view.pm line 46
File content/core/index.mdtext had processing errors: Error while rendering output to string
get http://s.apache.org/corejira failed.
{noformat}
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Grant Ingersoll (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13210360#comment-13210360 ]
Grant Ingersoll commented on LUCENE-3750:
-----------------------------------------
I hear you on the commit approach, just saying it is a workaround for now. For me, doing a commit doesn't take all that much longer than doing a local build unless you use --offline mode locally, in which case it skips the Twitter/JIRA stuff.
bq. Grant
Yes, I can. I talked w/ Yonik about it yesterday. I think we have different versions of the Py Markdown library (his is newer, mine is 2.0.3). Don't know if that is the issue. Mark, what version are you on?
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Grant Ingersoll (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13205434#comment-13205434 ]
Grant Ingersoll commented on LUCENE-3750:
-----------------------------------------
Or perhaps we just need to doc it better. If we can track down what's going on your machine, then perhaps that will help others avoid it or we can figure out that it is something nastier.
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Yonik Seeley (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13209602#comment-13209602 ]
Yonik Seeley commented on LUCENE-3750:
--------------------------------------
bq. if 1 out of N committers who have tried doing local www site builds can't get it to work
+1 more
I've spent the last few hours trying to get it to work on my OS-X (lion) box...
I figured out how to install the cpan perl modules (not being a perl person myself), and the python modules installed fine, but now the daemon just won't run:
{code}/opt/code/cms/build$ python --version
Python 2.7.1
/opt/code/cms/build$ export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd`
/opt/code/cms/build$ python markdownd.py
/opt/code/cms/build$ No handlers could be found for logger "MARKDOWN"
Traceback (most recent call last):
File "markdownd.py", line 41, in <module>
'codehilite', 'elementid', 'footnotes', 'abbr'])
File "build/bdist.macosx-10.7-intel/egg/markdown/__init__.py", line 395, in markdown
File "build/bdist.macosx-10.7-intel/egg/markdown/__init__.py", line 134, in __init__
File "build/bdist.macosx-10.7-intel/egg/markdown/__init__.py", line 166, in registerExtensions
ValueError: Extension "__builtin__.NoneType" must be of type: "markdown.Extension".
{code}
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Mark Miller (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13210381#comment-13210381 ]
Mark Miller commented on LUCENE-3750:
-------------------------------------
bq. unless you use --offline mode locally, in which case it skips the Twitter/JIRA stuff.
Bingo - I was looking for this option but couldn't find it in the doc anywhere - I could see in the perl code there was some offline option that skipped trying to do the JIRAs but I had no idea how to turn it on. That lets me get a local build going that works for me.
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Yonik Seeley (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13209655#comment-13209655 ]
Yonik Seeley commented on LUCENE-3750:
--------------------------------------
Heh - and I just tried the bookmarklet, and it crashed crome as soon as I tried to do an edit
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Grant Ingersoll (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13210319#comment-13210319 ]
Grant Ingersoll commented on LUCENE-3750:
-----------------------------------------
Also, I would suggest reporting your errors as bugs to infra or at least asking first (perhaps on site-dev@)
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Mark Miller (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13210347#comment-13210347 ]
Mark Miller commented on LUCENE-3750:
-------------------------------------
bq. FWIW, you can all just commit and then look at it in staging. You don't have to use the local build.
If you are doing anything but a minor change, that's a fairly nasty way to work on the site though (at least IMO). For website dev you really want to have immediate feedback and to be able to experiment and play around with having to commit each time. Honestly, I won't make any substantial change that way.
Just curious - is there anyone out there that has/can currently build the site locally?
Grant, I assume you still can?
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Grant Ingersoll (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13210318#comment-13210318 ]
Grant Ingersoll commented on LUCENE-3750:
-----------------------------------------
FWIW, you can all just commit and then look at it in staging. You _don't_ have to use the local build. I doubt we will run into too many people bumping up against each other and staging is only marginally slower than doing a local build anyway.
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Hoss Man (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13204827#comment-13204827 ]
Hoss Man commented on LUCENE-3750:
----------------------------------
FWIW: while i love the ability to do quick edits using the CMS bookmarklet, i have had absolutely zero success doing a full site build on my local machine -- i'm not even getting errors, i'm just getting no output.
this may just be something really flakey about my machine, but it begs the question: for our _versioned_ per release documentation, is there really any advantage to using markdown over simply editing HTML directly?
we used forrest for the versioned docs solely because once upon a time the entire site use to be versioned, and it was easy to just extract the versioned docs from the non-versioned docs and keep using forrest for both and have a similar look/feel, but is there really any reason why the versioned docs we ship in the release need to be in markdown and/or have the same look/feel as the website? yes, we'll archive them on the website for refrence, but we also archive the javadocs and we've never tried to make them look like the forrest docs (or the new site style)
why not just leave the versioned docs looking very simple, and very distinctive from the website, so when people browsing them online see them it's very obvious that they are *not* just part of the website, they are a snapshot of per version documentation?
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Hoss Man (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13205186#comment-13205186 ]
Hoss Man commented on LUCENE-3750:
----------------------------------
bq. I'll contact you on IRC and we can work through it.
I realize now i didn't not finish explaining the concerns i was trying to get to in that first para.
my comment was not intended to mean "i can't get local doc building to work for the www site, therefore i'm leary of using local doc building for the versioned docs". my comment was to be "if 1 out of N committers who have tried doing local www site builds can't get it to work, then that doesn't bode well for asking non-committer contributors to be able to use the same markdown tools to do local doc building of versioned docs that they might want to contribute patches for."
that smells like a big red flag to me.
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3750) Convert Versioned docs to
Markdown/New CMS
Posted by "Grant Ingersoll (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3750?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13204853#comment-13204853 ]
Grant Ingersoll commented on LUCENE-3750:
-----------------------------------------
I'll contact you on IRC and we can work through it.
Easier editing?
I don't know. I personally don't have the bandwidth to convert, but there is supposedly a Forrest-> Markdown plugin available.
--------------------------------------------
Grant Ingersoll
http://www.lucidimagination.com
> Convert Versioned docs to Markdown/New CMS
> ------------------------------------------
>
> Key: LUCENE-3750
> URL: https://issues.apache.org/jira/browse/LUCENE-3750
> Project: Lucene - Java
> Issue Type: Improvement
> Reporter: Grant Ingersoll
> Priority: Minor
>
> Since we are moving our main site to the ASF CMS (LUCENE-2748), we should bring in any new versioned Lucene docs into the same format so that we don't have to deal w/ Forrest anymore.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org