Consolidate and Implement Vocabulary across ancillary websites #329
Labels
💻 aspect: code
Concerns the software code in the repository
📖 aspect: docs
Concerns the documentation in the repository
🤖 aspect: dx
Concerns developers' experience with the codebase
🕹 aspect: interface
Concerns end-users' experience with the software
📄 aspect: text
Concerns the textual material in the repository
✨ goal: improvement
Improvement to an existing feature
🟨 priority: medium
Not blocking but should be fixed soon
🏁 status: ready for work
Ready for work
This is to document all of the tasks that'll be carried out during the Outreachy Dec 2024 cohort.
Note: It's a work in progress and subject to change.
Open Source website
The work was done in two phases;
Phase 1: Refactoring to Vocabulary Markup: This phase focused on aligning the HTML structure with the Vocabulary markup for matching contexts .
Phase 2:
Global Header
Before the start of the Outreachy program, efforts were made in the
vocab-refresh
branch to align the website's header with the global header component. During the program, the dropdown menu was removed from the header. However, there are plans to introduce dropdown functionality to Vocabulary in the future, so the dropdown menu might be reintroduced later.This change was part of a larger pr to refactor the home page of the website;
Global Footer
The footer menu was updated to align with the current menu structure, and the Twitter logo was replaced with Bluesky. These changes were made as part of a larger pull request:
However, during the refactoring phase, it was decided to include the menu from the legacy footer to provide a link to the archives page.
This adjustment was done in this commit: include old menu back into footer as part of
Recent Blog Posts
The recent blog was refactored to match vocab's context for blog index in pr;
Homepage
Many changes were made to the homepage, which includes several sections: the Hero section, Get Involved section, Recent Blog Posts, and Featured Projects. During the refactoring phase, all legacy classes were removed. It was also decided to refactor the Get Involved section and Featured Projects to match the ongoing initiative section.
During the restyling of the homepage, a pull request was made:
In this PR, the plugin section from the Get Involved section was removed, as there are plans to archive this page. This change is reflected in the remove our plugin commit
The Recent Blog Posts section, which resembled the Latest News section on the CC homepage, was restyled in the restyled recent blog post and changed order commit. Additionally, the Get Involved and Featured Projects sections were adjusted to display in grids of 2 instead of 3. The call to action in the hero section was also decided to remain links instead of the button in the legacy design as they were better suited as links.
Contribution, Work Program, Community Pages
Most of the pages and subsections under these categories were updated by refactoring the
page-with-toc.html
file in the codebase to align with the Vocabulary context.Community Team Page
as one of the pages not affected in the change made to the community page above, a pr was made to make changes to this page
In one of the previous discussions, there was a decision on how to handle instances where Vocabulary markup was not present for some of legacy code or vice-versa. This is explained in comment. As a result, the old table HTML markup was commented out and later reintroduced, as it was determined that presenting the data in a table format was the best approach, with all legacy classes stripped out.
Earlier efforts to align the team page with Vocabulary’s team markup faced an issue where placeholder images were used for team members instead of actual images. This led to the creation of the following issue:
One of the localizations made was the decision to use Datatables for styling the tables on the website. This change was included in this PR;
Project list page
In this PR, the featured projects was made to align with the same on the home page, and the active project was maintained in a table format.
The page was restyled in efforts made by this PR;
Issue Finder Page
Related issue and PR to this
Project idea page
Blog Page
This refactored the blog page to match the vocab-context for blog in this pr, this also involved making changes to the pagination
Another pr made in regards the issue above, for refactoring the page for each author to align with vocab's markup for person
It was in this pr, as stated in this comment that the route to dynamically add classes provided by vocabulary to reflect the page's styles was decided.
To refactor the page that displays all authors;
A pr was made to add the
blog-index
class for the blog post styles. Also, in this pr, pagination current display was fixedAfter the refactoring and due to the removal of legacy styles from the websites, some elements were not rendering properly, this was addressed in the issue and pr below,
[Feature] Adjust Blog Post Styling on CC Open Source Website creativecommons.github.io-source#892
adjusted styling on blog post creativecommons.github.io-source#903
Legal Database (Legal DB)
Homepage
Search Portal
Resource Archive
The text was updated successfully, but these errors were encountered: