Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakartaee-tck-dev] Proposed wiki update -- review / feedback encouraged
+1 from Suhrid Karthik

Best,
Suhrid

On Fri, Sep 11, 2020 at 10:19 AM Amelia Eiras <aeiras@xxxxxxxxxxxxx> wrote:

On Tue, Sep 8, 2020 at 1:12 PM Cesar Hernandez <chernandez@xxxxxxxxxxxxx> wrote:
Thank you for the update Ed,

I'm +1 on the wiki approach via GitHub pages.
After your PR the wiki content now has the same integration as the main project read me with the Jekyll template.

On Tue, Sep 8, 2020 at 1:39 PM Amelia Eiras <aeiras@xxxxxxxxxxxxx> wrote:
Hola Ed, 

Your timing is amazing.  Your prompt actions to execute from the discussions on the first Jakarta EE TCK OutReach Friday's call that followed the active TCK thread about TCK contributions and documentation make this a fun activity! 

Please Jakartees-- do join the TCK contributors' conversation either via this forum: this thread or a new thread &/or by attending the Fridays 9am PDT zoom calls. 

By the Community, For the Community!!! 



On Tue, Sep 8, 2020 at 11:31 AM Ed Bratt <ed.bratt@xxxxxxxxxx> wrote:

Hi there,

We had a meeting last week to consider improvements in community engagement with the Jakarta EE TCK project. One issue that was raised was the concern with the use of the GitHub wiki feature (Jakarta EE TCK Wiki). The issue expressed was that general community members have no way to directly manipulate the material that is provided by the GitHub wiki feature.

I took the action to generate a brute force conversion of the wiki pages, from their location on the GitHub wiki, into GitHub pages, which are served (for this project) from the Git branch, gh-pages. That "hack" is complete and is here.

It is a crude analog and doesn't yet have all the features that are available to the GH wiki but can serve as something that we/our-community can react to, regarding the pages, their content, and the usefulness -- in comparison to the GH Wiki pages themselves.

Please have a look -- JakartaEE GH Pages Wiki vs. the GitHub Wiki for Jakarta EE.

I believe the next feedback element is to hear voices from the community -- is this better than what we have with the GH Wiki?

From a conversion perspective, here are some comments I'd start with, (things that I would have done, had I been more facile with Jekyll):

  • Dynamic loading of page level links (I just brute-forced in the page list on the index page)
  • Dynamic organization -- perhaps this could be organized on directory/folder organization, currently the pages are all in one folder.
  • Perhaps some readability improvements to the template and style-sheets (Personally, I find the view from the GH Wiki a bit easier on my eyes)
  • Certainly extension of the core theme template to include a "Wiki" in the Left-side menu (I just conscripted the FAQ item for now)
  • Relative links for the fixed page items (the RHS menu, for example)

Some benefits are: anyone can submit PRs against this branch so community input can be directly accepted into these pages; We can have our own "branding"; We can tweak the template to our heart's desire.

It would be nice to get some feedback from non-committers as well as project committers. Maybe some PRs to add enhancements from those of you who are more familiar with Jekyll.

After some time for feedback, we will want to decide if we move forward and switch to a wiki approach via GitHub pages, or if we just decide to continue using GH Wiki.

-- Ed


_______________________________________________
jakartaee-tck-dev mailing list
jakartaee-tck-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-tck-dev
_______________________________________________
jakartaee-tck-dev mailing list
jakartaee-tck-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-tck-dev
_______________________________________________
jakartaee-tck-dev mailing list
jakartaee-tck-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-tck-dev
_______________________________________________
jakartaee-tck-dev mailing list
jakartaee-tck-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-tck-dev

Back to the top