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

Docusaurus footer needs to be updated #2881

Closed
cindyorangis opened this issue Feb 11, 2022 · 7 comments · Fixed by #2902
Closed

Docusaurus footer needs to be updated #2881

cindyorangis opened this issue Feb 11, 2022 · 7 comments · Fixed by #2902
Assignees
Labels
area: docusaurus Anything related to Docusaurus developer experience Helping the Developer Experience good first issue Good for newcomers type: documentation (docs) Improvements or additions to documentation
Milestone

Comments

@cindyorangis
Copy link
Contributor

Our Docusaurus footer needs some tender loving care.

2022-02-11 09_59_53-telescope - Visual Studio Code

Specifically:

  • The copyright should be Copyright (c) 2022 Telescope, Seneca's Centre for Development of Open Technology. Built with Docusaurus.
  • We don't have Stack Overflow, Discord, Twitter

I liked Supabase's footer so we can use theirs as a template

Product Resources Developers
Telescope Website System Status Documentation
Telescope Mobile Apps Terms of Service Slack
Planet CDOT Feeds GitHub
Staging Server

This is just a suggestion for our footer, if you feel there's a better way to organize links or something is missing or something doesn't need to be included, comment below :)

@cindyorangis cindyorangis added developer experience Helping the Developer Experience area: docusaurus Anything related to Docusaurus good first issue Good for newcomers type: documentation (docs) Improvements or additions to documentation labels Feb 11, 2022
@sancodes
Copy link
Contributor

If this is still open, I would like to help

@humphd
Copy link
Contributor

humphd commented Feb 11, 2022

Sure @sancodes, you're welcome to try it. @cindyledev can guide you if you need help.

@sancodes
Copy link
Contributor

@humphd thank you. I will get started on it.
if help needed, I will let @cindyledev know.

@cindyorangis
Copy link
Contributor Author

cindyorangis commented Feb 11, 2022

@samcodes thanks for taking this on!

Refer to environment-setup.md to get started.

We don't have Docusaurus hooked up to Telescope yet so you don't need to follow all the steps to get started with the Docusaurus site.

  • Clone the Telescope repository
  • Install pnpm globally: npm install -g pnpm
  • Install the dependencies: pnpm install (this will also install the dependencies in the Docusaurus website)
  • Change directory to src/docs (this is where all the code lives for our Docusaurus website): cd src/docs
  • Start the app: pnpm start
  • Visit localhost:4631 in your browser.

The code for the footer is at

footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Developer Docs',
to: '/docs/overview',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/Seneca-CDOT/telescope',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
},

URL links you'll need
Telescope Website: https://telescope.cdot.systems/
Telescope Mobile Apps: (no link available atm)
System Status: https://api.telescope.cdot.systems/v1/status/
Terms of Service License: https://github.com/Seneca-CDOT/telescope/blob/master/LICENSE
Planet CDOT Feeds: https://wiki.cdot.senecacollege.ca/wiki/Planet_CDOT_Feed_List
Documentation: (no link available atm)
Slack: https://seneca-open-source.slack.com/archives/CS5DGCAE5
GitHub: https://github.com/Seneca-CDOT/telescope

@sancodes
Copy link
Contributor

Screen Shot 2022-02-11 at 5 11 22 PM

Attached above is what is I have so far, with working links, and updates.

Couple of questions, I had were:

For the links:

  1. Telescope Mobile Apps
  • since we have no link for the mobile apps, I have mapped the link to the web link. Should I keep it as it is for now ? or remove the link for the mobile app link as a whole?
{
   label: 'Telescope Mobile Apps',
   to:'https://telescope.cdot.systems/'
}
  1. Terms of Service
  • In our Resources section, I've added the link name/label as Terms of Service as per the direction given in the table.
  • however the link directs to License, so should the link name/label still be Terms of Service or changed to License?
{
    label: 'Terms of Service',
    href: 'https://github.com/Seneca-CDOT/telescope/blob/master/LICENSE',
}
  1. Documentation
  • since we have no link for the documentation. I have still have mapped it to the docusaurus.io/docs/ link. Should the link be removed completely?
{
    label: 'Documentation',
    href: 'https://docusaurus.io/docs/',
}
  1. Staging Server
  • there was nothing mentioned about Staging Server regards to the link. Can you provide me the link for that?

As per the styling:

How do I go about styling the footer? Can you guide me on that?

  • I do have some basic CSS knowledge.

@cindyledev

@cindyorangis
Copy link
Contributor Author

@sancodes thank you for getting to this so quickly! We really appreciate your efforts

however the link directs to License, so should the link name/label still be Terms of Service or changed to License?

The name/label should be changed to License

since we have no link for the documentation. I have still have mapped it to the docusaurus.io/docs/ link. Should the link be removed completely?

Leave the link as is. We will update it after #2865 has been fixed

there was nothing mentioned about Staging Server regards to the link. Can you provide me the link for that?

Whoops, I totally forgot to give you the link in the last comment. The link for the staging server is https://dev.telescope.cdot.systems/

@sancodes
Copy link
Contributor

@cindyledev
Thank you for the link.
I have added all the links respective to its label.
I created a pull request and have filled out Merge Request instruction's answers.
Please Let me know if everything is working fine.

@menghif menghif added this to the 2.7 Release milestone Feb 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docusaurus Anything related to Docusaurus developer experience Helping the Developer Experience good first issue Good for newcomers type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants