Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Beautify docsy site page #603

Open
jpolton opened this issue Nov 24, 2022 · 10 comments
Open

Beautify docsy site page #603

jpolton opened this issue Nov 24, 2022 · 10 comments
Assignees

Comments

@jpolton
Copy link
Collaborator

jpolton commented Nov 24, 2022

Landing page for documentation is not very informative: https://british-oceanographic-data-centre.github.io/COAsT/

rename the landing page buttons to where they link to

@thogar-computer
Copy link
Member

I think this page https://british-oceanographic-data-centre.github.io/COAsT/about/ also needs rework

@thogar-computer
Copy link
Member

thogar-computer commented Oct 24, 2023

anaconda section could link to the coast package
Twitter section either points to a COAsT twitter page or is removed.
Contributions welcome section should be updated to make it clear that it links to the documentation repo

see https://british-oceanographic-data-centre.github.io/COAsT/#td-block-1

@thogar-computer
Copy link
Member

https://british-oceanographic-data-centre.github.io/COAsT/community/

This then points out to the pypi version (should we also include the anaconda links here)

@thogar-computer
Copy link
Member

@thogar-computer thogar-computer changed the title Beautify main docsy site page Beautify docsy site page Oct 24, 2023
@thogar-computer
Copy link
Member

look to see if docsy can be update in backend (is there new feature/bug fixes)

@soutobias soutobias self-assigned this Oct 31, 2023
@soutobias soutobias moved this from BODC - Todo to BODC - In Progress in COAsT_dev Oct 31, 2023
@soutobias
Copy link
Collaborator

@jpolton , I update the website template. Could you please take a look at this video to check if you want to change anything?

Screencast.from.01-11-23.14.33.07.webm

@soutobias
Copy link
Collaborator

soutobias commented Nov 1, 2023

I've made several enhancements to the website, including:

  1. Adjusted the title font for better readability.
  2. Revised the banner background by adding opacity to improve its legibility with text overlaid.
  3. Streamlined the "about" and "community" pages, transferring all relevant information to the main page. Navigation links in the navbar now guide users to specific sections based on their corresponding "id."
  4. Removed all references to Docsy for a cleaner and more tailored look.
  5. Introduced fresh content related to the project, with the possibility of offering more comprehensive descriptions of the package's features and capabilities in the "About" section.
  6. Included license information in the footer of the website.
  7. Regarding the "Getting Started at Liverpool" section, I've removed it from the documentation. I've created a temporary page on the NOC Intranet and added this link to the "Getting Started" page. Please note that we may need to update this link in the future.
  8. As I made some modifications to the Docsy theme, I've copied certain Docsy partials to the main repository, specifically the footer and header.
  9. Additionally, I've included new CSS classes and images in the repository's assets. Some adjustments to the Docsy CSS were necessary to implement these changes effectively.
  10. I also updated the install instructions on the README file.

@jpolton
Copy link
Collaborator Author

jpolton commented Nov 2, 2023

All looks great.
Perhaps the COAsT/README needs a review, (with a new ticket)?

@soutobias
Copy link
Collaborator

I created the pull request here British-Oceanographic-Data-Centre/COAsT-site#95

@soutobias
Copy link
Collaborator

I will merge these updates into the develop branch

@soutobias soutobias moved this from BODC - In Progress to Merged to Develop in COAsT_dev Nov 6, 2023
@soutobias soutobias moved this from Merged to Develop to Done in COAsT_dev Nov 7, 2023
@soutobias soutobias moved this from Done to Merged to Develop in COAsT_dev Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Merged to Develop
Development

No branches or pull requests

3 participants