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

Piergiorgio Lucidi commented on CONNECTORS-1495:
------------------------------------------------

Hi [~sonosolobit],

discussing with [~kwri...@metacarta.com] we would like to approach to Jekyll in 
a light way, this means that before looking at the documentation, we could try 
to use Jekyll only for the website and then approach to the complex part.

We could learn Jekyll approaching with the website (Step 1) and then we will 
rearrange the documentation (Step 2).

In order to simplify the process we could use an existent template in the 
Apache Community that is actually using Jekyll, probably CloudStack could be a 
good start.

Below my comments about your questions:
 # The site structure needs to be rethought in a way that better adapts to the 
jekyll folder structure. In particular, we need to consider the multilingual 
nature of the actual site. We need to consider also that in jekyll we can use 
the tag or category system to group the pages.

+1 from me.

 
{quote}2. How can we use (if it’s possible) the markdown syntax with the 
asiatic languages? 
{quote}
I don't know :P we have to look at it closely.

 
{quote}3. Jekyll hasn’t a native search engine. As suggested by Piergiorgio, we 
could use solr (like now). In that case we might need to modify the jekyll 
theme to integrate the search form and the results page. 
{quote}
I'm pretty sure that we can find something that can allow us to index our 
content, for example something similar to the following:

[https://github.com/andyfowler/jekyll-plugins/blob/master/solr.rb]

 
{quote}4. A manual conversion of the existing pages in markdown isn’t too 
difficult or too long. The text structure is quite simple. The slowest (and 
boring) part is related to the insertion of the inline images and the rebuild 
of the tables.
{quote}
If we find the right syntax we can work together and divide the effort in an 
appropriate way, we are a community: you are not alone ;)

 
{quote}5. We should consider splitting the longest documents in smaller pieces 
(for example the "end user documentation").
{quote}
+1 but during Step 2.
{quote}6. We need to select the jekyll plugins (syntax highlight, image 
manager,  tables, etc) to use for the site. The jekyll plugin list is here: 
[https://jekyllrb.com/docs/plugins/|https://jekyllrb.com/docs/plugins/)]
{quote}
The first one is required to index the content against Solr:

[https://github.com/andyfowler/jekyll-plugins/blob/master/solr.rb]

I think that we only need to start and then during our work we will start to 
choose plugins dedicated to different capabilities.

> Brand new website
> -----------------
>
>                 Key: CONNECTORS-1495
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-1495
>             Project: ManifoldCF
>          Issue Type: New Feature
>          Components: Site
>    Affects Versions: ManifoldCF 2.9.1
>            Reporter: Piergiorgio Lucidi
>            Assignee: Piergiorgio Lucidi
>            Priority: Major
>             Fix For: ManifoldCF next
>
>   Original Estimate: 480h
>  Remaining Estimate: 480h
>
> The community decided to work on a brand new website:
> [http://mail-archives.apache.org/mod_mbox/manifoldcf-dev/201712.mbox/%3CCAHVHQx8odjgXMw%3DnhmSeDt0pYOUd0j%2BtkmMNtFnCJvHFcZwyEg%40mail.gmail.com%3E]
> The proposed technology is Jekyll but we have also to decide the website 
> template to use.
> [~kamaci] suggested the [Apache CloudStack|https://cloudstack.apache.org/] 
> template.
> [~molgun] proposed this approach:
>  # Find a modern new static site generator like Jekyll [1]
>  # Create a template
>  # Start to use it in a specific path like 
> [https://manifoldcf.apache.org/*new*]
>  # Migrate our Forrest xml's to Markdown (we can automate this somehow)
>  # Start to serve our new site on root path
> [1] [https://jekyllrb.com/docs/home/]
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to