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

Add About page #54

Open
5 tasks
xypnox opened this issue Sep 22, 2020 · 7 comments
Open
5 tasks

Add About page #54

xypnox opened this issue Sep 22, 2020 · 7 comments
Assignees
Labels
enhancement New feature or request Hacktoberfest This issue counts towards Hacktoberfest contributions

Comments

@xypnox
Copy link
Member

xypnox commented Sep 22, 2020

Add an about page to the site to list:

  • About LTTKGP
  • Features
  • FAQs
  • GitHub Org and Slack Workspace links
  • Change-log/Link to a changelog elsewhere

The About page can be added as an info icon above the theme switcher.

The design of the about page should be attractive as it will be the primary source for users to know about LTTKGP.

@xypnox xypnox added the enhancement New feature or request label Sep 22, 2020
@ghostwriternr ghostwriternr added the Hacktoberfest This issue counts towards Hacktoberfest contributions label Sep 26, 2020
@haripriya9647
Copy link

Hey I would like to work on this issue .Can you assign me @xypnox

@xypnox
Copy link
Member Author

xypnox commented Dec 12, 2020

Sure, First create a PR with a basic structure of the page. A simple heading and paragraph would suffice.

Also, we will decide the linking later so for now just keep it at /about.

@haripriya9647
Copy link

haripriya9647 commented Dec 12, 2020 via email

@xypnox xypnox linked a pull request Dec 13, 2020 that will close this issue
@sahil-shubham
Copy link
Contributor

sahil-shubham commented Jan 7, 2021

Hey @xypnox, I was working on the about page but couldn't understand the point regarding Change-log/Link to a changelog elsewhere. Any kind of help in understanding this would be appreciated, thank you.

@xypnox
Copy link
Member Author

xypnox commented Jan 7, 2021

So usually most applications have a changelog, a place where we explain what new things were added in each version of the app. For example of a changelog you can check out: Firefox Releases, Alacitty terminal releases etc.

Since LTTKGP is made up of a different parts, with various microservices and an uncoupled frontend, we would not want to maintain different project's changelogs separately in their release pages. Keeping them in one easy to digest place would be ideal and it is nice in about page as that changelog can be used to tell people about any new features we add, such as YouTube music support.

Therefore we need a sort of list that highlights the features added, bugs fixed etc.

One way is to have a local markdown file making it trivial for anyone to modify the changelog. We can have lists, images and links in markdown and complex components would not be necessary in the frontend, just a markdown renderer would suffice.

@sahil-shubham
Copy link
Contributor

@xypnox Thank you very much for the detailed explanation. I have a good understanding of what to do now. I will create a PR in a few days and then we can discuss the content for the other points mentioned in the issue.

@xypnox
Copy link
Member Author

xypnox commented Jan 24, 2021

@sahil-shubham While you are at it also update the deployment URL in the README, currently it links to beta.lttkgp.com, we need it to be lttkgp.com

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Hacktoberfest This issue counts towards Hacktoberfest contributions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants