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

Update README screenshots #33347

Merged
merged 2 commits into from
Feb 18, 2025
Merged

Conversation

yp05327
Copy link
Contributor

@yp05327 yp05327 commented Jan 22, 2025

@lunny @techknowlogick
Wait for the update of https://dl.gitea.com/screenshots
Can you move all old screenshots into https://dl.gitea.com/screenshots/old ?
Then run the action to upload new screenshots to https://dl.gitea.com/screenshots

Follow #33149.
As I mentioned here: #33149 (comment), the prepare process is almost finished.
The backend technical is using newly added workflow_dispatch feature for Gitea Action to take the screenshots automatically.
Then we can easily sync the screenshots to the latest version without annoying manual work.
Get more information from https://gitea.com/gitea/deployment

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 22, 2025
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 22, 2025
@silverwind
Copy link
Member

Can you show one example screenshot? Just want to verify they are in sufficient resolution etc.

@lunny
Copy link
Member

lunny commented Jan 22, 2025

Can you show one example screenshot? Just want to verify they are in sufficient resolution etc.

I believe all the screenshots have been added in https://dl.gitea.com/screenshots/2025/ .

@silverwind
Copy link
Member

I see, they look good.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 22, 2025
@silverwind
Copy link
Member

silverwind commented Jan 23, 2025

The new layout in markdown may be quite vertical (I'm not sure because preview is not working yet).

If it is one image per line, consider putting the images aside each other by removing the newlines.

@hiifong
Copy link
Member

hiifong commented Jan 23, 2025

I think it would be better to control the presentation of the screenshot through the img tag in HTML.

@silverwind
Copy link
Member

silverwind commented Jan 23, 2025

Up to you whether you do it in markdown or HTML. Benefit with HTML is you can specify width:

<div>
   <img width="200">
   <img width="200">
   <img width="200">
   <img width="200">
</div>

@silverwind silverwind self-requested a review January 23, 2025 15:48
@GiteaBot GiteaBot added lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 23, 2025
@yp05327
Copy link
Contributor Author

yp05327 commented Jan 24, 2025

Up to you whether you do it in markdown or HTML. Benefit with HTML is you can specify width:

Users may have different resolutions, if the width is a const, it may be too small or too big?
Then use css to fix this issue? Then readme may include may html codes?
This is my thought about this.

@silverwind
Copy link
Member

silverwind commented Jan 24, 2025

Users may have different resolutions, if the width is a const, it may be too small or too big?

Resultion of the thumnails will be greatly sufficient, I'd say put 2-4 per line.

Then use css to fix this issue? Then readme may include may html codes?

Markdown does not allow CSS. Only a limited set of HTML attributes work.

Ideally I'd wrap each screenshot in a link, e.g. <a><img></a>.

@yp05327
Copy link
Contributor Author

yp05327 commented Jan 24, 2025

As this is still WIP, we can gather more opinions on it.
IMO, the original image seems large enough, so I don't need to click on it to check the details.
If we put 2-4 per line, sometimes I need to click on it to check the details.

@silverwind
Copy link
Member

silverwind commented Jan 24, 2025

IMO, the original image seems large enough, so I don't need to click on it to check the details.
If we put 2-4 per line, sometimes I need to click on it to check the details.

README markdown rendering on GitHub and Gitea will in any case render images at most at like 1000 CSS pixels, so the image will always be downscaled to 50% or more, even in full width.

I think having 20+ full-width images will be far too excessive, if only for the scrolling effort needed.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 31, 2025
@silverwind
Copy link
Member

Can we fix all the links? Currently only one is working.

@yp05327
Copy link
Contributor Author

yp05327 commented Feb 1, 2025

Can we fix all the links? Currently only one is working.

The links are all correct. The screenshots are not prepared yet.

See: https://gitea.com/gitea/deployment/actions/runs/29
It seems that the s3 token does not have permission to upload files to screenshots folder.
I could not fix this. So still waiting for the upload

@silverwind
Copy link
Member

Hmm yeah looks like IAM rules need an adjustment there, @techknowlogick.

@a1012112796
Copy link
Member

status?

@silverwind
Copy link
Member

silverwind commented Feb 13, 2025

Alternatively commit the screenshots to the repo? I don't think a few MBs will hurt and this will make the screenshots easily updateable by anyone.

@yp05327
Copy link
Contributor Author

yp05327 commented Feb 18, 2025

@yp05327 yp05327 marked this pull request as ready for review February 18, 2025 08:06
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Feb 18, 2025
@lunny lunny added type/docs This PR mainly updates/creates documentation reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. labels Feb 18, 2025
@lunny lunny merged commit 241f799 into go-gitea:main Feb 18, 2025
26 checks passed
@GiteaBot GiteaBot added this to the 1.24.0 milestone Feb 18, 2025
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Feb 18, 2025
@silverwind
Copy link
Member

silverwind commented Feb 18, 2025

Why not commit screenshots to repo? Do we want to make it extra hard to update them?

Also, @lunny should have waited on my review. Please stop merging PRs that have open discussions.

@lunny
Copy link
Member

lunny commented Feb 18, 2025

Why not commit screenshots to repo? Do we want to make it extra hard to update them?

Also, @lunny should have waited on my review. Please stop merging PRs that have open discussions.

Sorry, I missed that.

Since the images are not small, it should not be put in this repository. We can update with scripts in deployment repository. I don't think it's too difficult.

zjjhot added a commit to zjjhot/gitea that referenced this pull request Feb 19, 2025
* giteaofficial/main:
  Fix PR web route permission check (go-gitea#33636)
  fix: add missing locale (go-gitea#33641)
  Fix Untranslated Text on Actions Page (go-gitea#33635)
  Improve button layout on small screens (go-gitea#33633)
  Update README screenshots (go-gitea#33347)
@yp05327 yp05327 deleted the update-readme-screenshots branch February 24, 2025 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants