search

jakartaee / jakarta.ee

Jakarta EE is the future of cloud native Java. Jakarta EE open source software drives cloud native innovation, modernizes enterprise applications and protects investments in Java EE.
https://jakarta.ee
Eclipse Public License 2.0
168 stars 94 forks source link

Need a Committees index page with navigation #597

Closed starksm64 closed 4 years ago

starksm64 commented 4 years ago

Is your feature request related to a problem? Please describe. There is no content tree for the steering, specification and marketing committee specific documents.

Describe the solution you'd like We should have a have a top level landing page that has a link from the Resource menu to a Committees page that lists the Steering, Specification, and Marketing Committees with associated subpages, and then have an index page for each committee that links to the relevant committee documents.

Describe alternatives you've considered Previously content has existed in the committees specific github repository.

Additional context

The #594 issue to add the TCK process guide to the website leaves that content orphaned without any top level navigation or index page for the various committees.

chrisguindon commented 4 years ago

+1 for creating a new landing page.

Who is responsible for creating the initial content that we can use to create the page?

chrisguindon commented 4 years ago

Should we use the content from https://github.com/jakartaee/jakarta.ee/issues/593 to create the initial landing page?

We could then add links to each committee at the top of the page?

bshannon commented 4 years ago

The document from #593 would be one of the items linked to from the landing page, along with the committee-specific landing pages.

autumnfound commented 4 years ago

I've created a quick mockup of the page here: https://deploy-preview-599--jakartaee.netlify.com/committees/

The content was just a quick slapdash, but I wanted to get an idea down and pass it along. Something that might take more consideration is where will we put a link to this new top-level page, as our header is currently as full as we can get it with current styling/links.

image

bshannon commented 4 years ago

I don't think that's quite what we want.

The top level "committees" page should just list the committees and give a brief description of their purpose. It should link to a level level page, one for each committee, where there will be more information about each committee, including links to various document relevant to the committee - operations, process, meeting schedule, meeting minutes, etc.

starksm64 commented 4 years ago

I agree with @bshannon

chrisguindon commented 4 years ago

@autumnfound Thanks for your work on this so far!

I've unassigned you from this issue for now since I don't believe we are ready to implement this just yet.

We need to formulate a proposal based off feedback from this issue and then ask the community to give us feedback on our proposal. @TanjaObradovic is currently working on that!

Once this is done, we should be ready to execute on this task.

waynebeaton commented 4 years ago

How about we just add a "Committees" link to the main page that points to the committees directory for now. This would be a simple fix that gives us navigation to the content without having to put any effort into updating the index page when new content is added (Hugo will automatically update it).

In parallel, we can work out and implement a more complete solution.

TanjaObradovic commented 4 years ago

As promised on the Specification Committee today we are expected to provide an update on how we plan to implement this and provide mockup. We can do as Martin suggested, we can add it to the About page, or under Resources drop-down, as Scott suggested. Whatever makes the most sense. @chrisguindon @shabnammayel

chrisguindon commented 4 years ago

What is the request?

  1. Create a hierarchy from jakarta.ee that will have the following structure

    • jakarta.ee/committees
    • jakarta.ee/committees/specification
    • jakarta.ee/committees/steering
    • jakarta.ee/committees/marketing

  2. and visibly accessible from jakarta.ee.

Proposed solution from EF webdev team

PR link: https://github.com/jakartaee/jakarta.ee/pull/604

  1. Create a hierarchy from jakarta.ee that will have the following structure

  2. and visibly accessible from jakarta.ee: https://deploy-preview-604--jakartaee.netlify.com/about/

I added a learn more button below our list of committee members.

chrisguindon commented 4 years ago

I don't think that's quite what we want.

The top level "committees" page should just list the committees and give a brief description of their purpose. It should link to a level level page, one for each committee, where there will be more information about each committee, including links to various document relevant to the committee - operations, process, meeting schedule, meeting minutes, etc.

I will need a description for each committee.

chrisguindon commented 4 years ago

and visibly accessible from jakarta.ee: https://deploy-preview-604--jakartaee.netlify.com/about/

I added a learn more button below our list of committee members.

I can add a temporary Committee link under the top-level resource link as suggest by @starksm64 if my proposal is not enough!

Will someone step up and contribute content for these sections/pages? I don't think that I am best person to describe each of these committees :)

I would like us to focus on what we need to change to push this production!

My PR is not perfect but I am hopeful that we can make incremental improvements after this is live!

TanjaObradovic commented 4 years ago

I believe @chrisguindon proposal will work, however we do need a write-up for each page. We will get back to you regarding the text. If any objections from the community - please let us know.

shabnammayel commented 4 years ago

Chris please use this document for the copy Content for _committees (2).pdf

chrisguindon commented 4 years ago

@shabnammayel Thanks for the content but it seems that the link from https://deploy-preview-604--jakartaee.netlify.com/committees to https://deploy-preview-604--jakartaee.netlify.com/committees/primer-on-committee-responsibilities.pdf has been drop in this pdf.

Is that on purpose?

shabnammayel commented 4 years ago

no it is not. and it's strange since I don't see that link in the pdf document that I attached when I download it.

chrisguindon commented 4 years ago

I added a description for each committee: https://deploy-preview-604--jakartaee.netlify.com/committees/

@shabnammayel I added a link to the pdf on the word responsible.

Please advise if this is incorrect. The original request was made by @TanjaObradovic via https://github.com/jakartaee/jakarta.ee/issues/593

I closed that issue and moved the conversation here since we are using this issue to create this new section!

chrisguindon commented 4 years ago

I created a new Documents section on the committee landing page for these generic documents: https://deploy-preview-604--jakartaee.netlify.com/committees/

Please let me know if I need to change anything else!

starksm64 commented 4 years ago

I think that looks pretty good. The only thing I don't see is navigation to the Committees page from the Resources pulldown menu,

chrisguindon commented 4 years ago

@starksm64 I added it now: https://deploy-preview-604--jakartaee.netlify.com/committees/

shabnammayel commented 4 years ago

Please find the updated content. there;s been some minor changes Content for _committees (3).pdf

chrisguindon commented 4 years ago

Please find the updated content. there;s been some minor changes Content for _committees (3).pdf

Done: https://deploy-preview-604--jakartaee.netlify.com/committees/

Is there any more changes needed for this?

starksm64 commented 4 years ago

I think that is good enough for the initial issue.

chrisguindon commented 4 years ago

I think that is good enough for the initial issue.

Thanks! The page is now live :) https://jakarta.ee/committees/

TanjaObradovic commented 4 years ago

@chrisguindon Many thanks!

bshannon commented 4 years ago

Sorry, I can't keep up with all this reviewing...

I think the lower level index pages should be titled (e.g.) "Specification Committee", not just "Specifications". The latter is way too ambiguous. Ditto "Marketing Committee" and "Steering Committee".

chrisguindon commented 4 years ago

I created a PR to add the word Committee in the title of each committee: https://deploy-preview-611--jakartaee.netlify.com/committees/

chrisguindon commented 4 years ago

The commit was merged in! Closing this issue!

Please create a new issue for any new changes!