Feature proposal: profile readmes

[ptman]

Description

Basically a clone of github profile readmes. Such a good feature that's built on git. Hopefully easy to implement, as it builds on the ability to render README.md that already exists.

Screenshots

This repository README.md https://github.com/simonw/simonw is visible at https://github.com/simonw

[fangmarks]

This'd be a really neat feature!

I currently link my main Account on my own Instance, but it would be neat if I could write a profile readme to basically list all my works, since they're not in one place and not every account on my instance is mine.

i.e. I could do something like this:

- [Account Name](LINK)
  - [Project](LINK)
  - [Project](LINK)

- [Account Name](LINK)
  - [Project](LINK)
  - [Project](LINK)
  - [Project](LINK)
  - [Project](LINK)

This would make it, for me personally, easier to even put my personal Gitea on a Résumé/CV and then make it easy for potential employers to look through my works

[jolheiser]

What are thoughts on this simply being a field in profile settings?

Does it need to be in a magical repo with the same name as your username? (It does on GH, but in terms of Gitea)

I suppose being in a repo allows users to hook it into CI, but a repo with a single README always struck me as hacky.

[ptman]

Repo is much nicer, with history etc. Only put stuff in the DB when it needs to be queried.

[fangmarks]

i like how github did it tbh

[christaus]

We are in 2021 and I strongly agree with this feature, I fond this webpage looking for a way to use a README.md as profile on gitea.
This is absolutly a great idea on github, that could be on gitea.
Thank you for the one who will change the world to me 👍🏻 .

[lunny]

Where should we store the README.md? how about in a git repository named <user_name>/-/profile, so that you can git clone it and push to server?

[CodeDoctorDE]

In github its github.com/Username/Username

[lunny]

github.com/Username/Usernam maybe conflicted with user's repository. i.e. gitea/gitea. Or /~<user_name>, I think it's compatible with something.

[CodeDoctorDE]

On orgs, github uses .github as repository name like https://github.com/LinwoodCloud/.github.
Maybe gitea.com/Username/.gitea repository?

[lunny]

On orgs, github uses .github as repository name like https://github.com/LinwoodCloud/.github. Maybe gitea.com/Username/.gitea repository?

That sounds also OK.

[christaus]

Simply like that: https://github.com/cGIfl300 it is stored on https://github.com/cGIfl300/cGIfl300 indeed the repository using your own nickname is indicated as "special" and the README.md is show next to your profile. (you can see my profile, I do use it)

[lunny]

Or we can reuse repository_type, so it's a profile repository, other types are template and etc.

[togetherwithasteria]

Don't forget to also implement this on organizations.

[MisileLab]

This feature would be great!

[mind-overflow]

hey! no update on this?

[hrueschwein]

Also waiting for this :)

[pratik9315]

Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :)

[justusbunsi]

Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :)

@pratik2315 Contributions are always welcome. The issue is still open, there is no PR referenced, so... grab yourself a cup of tea and create some magic, I'd say. 😉

Feel free to join the Gitea Discord server in case you have questions. There is also a develop channel.

[goodevilgenius]

Implementation-wise, I think calling it username/.profile would be better than username/username or username/.gitea.

Problems with the former have already been mentioned. For the latter, I just think something more neutral than .gitea would be better.

Additionally, this could be the basis for future features, as GitHub allows an org to put org-wide issue templates in this repo also. Something like that might be a useful feature in the future.

[CodeDoctorDE]

I'm currently trying to implement this :)
I post my pull request here if I'm finished

[LAX18]

Do we like something to the effect of this? I am starting to work on this preliminarily.

[twisted-nematic57]

@LAX18 I suppose the message could be a bit more descriptive...

How about "{username}/.profile's README.md will be displayed here."

[LAX18]

I was meaning more about the placement. Eventually it won't be visible at all if there is not a username/.profile repository. As per Github's approach AFAIK

[twisted-nematic57]

Yeah, the placement is good.

[delvh]

PR was merged but didn't close the issue.