Help wanted: Moving GnomeCommander homepage from GitHub to GitLab

Hello all,

the project homepage of GnomeCommander has become quite ancient. While the next major release of GnomeCommander gets closer, I thought it would be a good idea to move the homepage to the Gnome GitLab infrastructure and maybe at the same time renew the look and feel of it.

If there is someone out there who could help with that project and has some free time, I would be more than happy about that.

Also, although there is an official GitLab documentation for GitLab pages, I wonder if there is something Gnome specific which has to be obeyed? If yes, can somebody point me to that?

Thank you
Uwe

2 Likes

No, it’s pretty much the same. At least it was for me when I played with it. Just needs CI set up and website is there :slight_smile:

1 Like

Have you considered applying GnomeCommander to GNOME Circle apps? It is a bit strange, that application with “GNOME” in its name is not there already. Each application gets its own, standard web page with all important links; e.g. Calculator – Apps for GNOME . Project would get a modern minimalist website and reduce the burden of maintaining a separate website. Not to mention other benefits of GNOME Circle.

1 Like

I don’t think the app is eligible without a major overhaul of its UI (which may not be wanted by the app developers and users)

How large of a refresh are you thinking of? Keeping website old content and updating the theme, or parking old website on separate domain and building something fresh, with less content from current website? I am no designer, so maybe borrowing (with appropriate credits, of course) something from GNOME website templates might do?

Quick overview of what I found by browsing GnomeCommander website and source:

  • website in built with Jekyll static site generator
  • has 8 main pages: /index (Home), /shots (Screenshots), /download, /doc (Documentation), /dev (Development), /oldnews (All news), /opt_show (Options slideshow), /keys (Keyboard shortcuts)
  • has RSS atom feed for news posts
  • 121 news posts

Updating documentation and images to match most recent release will be quite bit of work.

A bit off topic, but I find this interactive options preview amazing: GNOME Commander - Options slideshow . Would be neat to build something in same spirit for new version :slight_smile:

Right, at the moment it is not planned to convert the application to the modern look and feel of Gnome core apps, @joshas. The “Gnome” part in the name is somehow legacy from the early days. There was a discussion to remove the name “Gnome” in most of the apps some time back, but just “commander” would be a too short, so it was decided to leave it as is for the time being.

Quick overview of what I found by browsing GnomeCommander website and source:

  • website in built with Jekyll static site generator

  • has 8 main pages: /index (Home), /shots (Screenshots), /download, /doc (Documentation), /dev (Development), /oldnews (All news), /opt_show (Options slideshow), /keys (Keyboard shortcuts)

  • has RSS atom feed for news posts

  • 121 news posts

Thanks for the analysis, @joshas. Something simple with less content, but responsive for smartphone displays would be great (→ this is something which I miss for the current webpage.)

When looking at the old page, the screenshot, the documentation, the slide show (yes, its nice ^_^) and the keyboard pages are not really needed since they are almost all out of date. I would prefer to have less content to reduce maintenance duty. Even the rss feed and all the old posts don’t need to exist.

Let’s start figuring out which content exactly is necessary to be presented on the website, and after everyone is happy with it - we’ll proceed with actual website design.

I’ve converted all content to markdown and did initial clean up, leaving only three pages: Home, Development and Download. Here is a website build by Jekyll: https://gcmd-website-dev-f1890d.gitlab.io/ . Source will be shared a bit later. Please don’t be alarmed by the lack of any styling - main focus is on content for now. Also apologies for repeating website title and page titles. Many headlines were left as is just to make communication easier.

And along with this preview I made a long list of tasks/questions to figure out about content on the website. Please take your time answering and bring your own ideas.

Initial content cleanup and structuring

Application name: “GnomeCommander”, “GCMD”, “GNOME Commander” (in application title), “Gnome-Commander” - select one and use only it on the website. Now it is a bit confusing having several names.
Do we need a section (block) to display latest release version number and release date? Link to dowload page?
Should some badges (version tag, license, translations, pipeline status) be kept on new website?
Consider reducing content on website by moving some more technical information to documents in repository, like README.md and CONTRIBUTING.md? Or linking to other websites, e.g. information regarding translations (those are standard processes for all GNOME progress, and might change in the future). gentoo build section sounds like it surely should end up in “BUILD.GENTOO” document. GitLab repository sections could be better utilized, like releases or wiki.
Do we want to display more application screenshots on homepage or other pages? I’m not a fan of carousels or thumbnail/lightbox solutions. Having one or two screenshots from application inline might be more than enough.
Coherent punctuation in lists: either we end all with dot or semicolon or nothing at all, but not a mix of various options.
When to use “code line” (backticks), and when to use “code block” (three backticks block) formatting? Long shell commands does not fit on mobile screens.
Should we add “copy to clipboard” button to code blocks, as some visitors might expect such feature?

Main page/Index/About

Rephrase “kill bugs” into something more neutral, like “fix issues”. Maybe “bugs” section should be renamed to “Issues” or “Reporting issues?” to match vocabulary used in GitLab.
Display organization names in donation links, not URLs? Add more? Remove something?

Download

Add more Linux distributions to pre-built packages: Ubuntu, Slackware? Maybe some more big names are missing?

Development

Rename “Development” page to “Contribute”, as there are more ways to contribute than only development. Check Welcome to GNOME – Files for inspiration on how to lay out all the information. Adding section about quality assurance and security testing would be useful.
Link current/future plans to appropriate milestones in GitLab?
“current stable” branch number in terminal command quickly gets old. Nobody is going to update this after each release. Some clever workaround is needed here. Or a command line to quickly find latest stable version number.
Building from source: it would be useful to list what dependencies are required to build project. No need to list every one for each distribution, but some general list. Probably should be moved to repository, along with all technical information.
Compendium/compendia? What is the difference? What is correct spelling?
Update application title and new URL of “Gtranslator”
Ask someone from translation team to review the “Contributing by Translating” section. Maybe link to official GNOME docs?

Design and layouts

Do we want to display slogan “A powerful file manager for the GNOME desktop environment” under application title in navigation bar (header)? Or move it to about section and keep header clean?
Is current layout “External packages” looking good? Should we simplify it by making icons larger, so tap targets would be bigger on mobile? Would be nice to keep this part simple and not to go building custom HTML layouts. We could use distribution logos with names inside them. There is always alt text available for accessibility.
Use 4:3 aspect ratio for screenshots to fit all screens better and showcase more content.
Dark mode and use application screenshot taken in dark mode in it.

Final cleanup

After website is complete, update “Updating the Homepage” section. New link to website repository, info how to report issues and create MRs with content changes.
Run a spellcheck and grammar check on all final text.
Check all external links, if any are broken or being redirected. Use direct links whenever possible.
Go through ALL software download websites and figure out how to update gnome-commander to latest version, as most have very old versions showcased.

Apologies in advance for large wall of text. We can work on one section at a time :slight_smile: .

Great stuff! Thanks for this first version. I really like the clean look. Let me answer your questions:

Application name: → “Gnome Commander”
Do we need a section (block) to display latest release version number and release date? Link to dowload page? → A static link to Gnome Commander Releases at GitLab would be sufficient.
Should some badges (version tag, license, translations, pipeline status) be kept on new website? → no, can be removed (the license can be mentioned in the text)
Consider reducing content on website by moving some more technical information to documents in repository, like README.md and CONTRIBUTING.md? Or linking to other websites, e.g. information regarding translations (those are standard processes for all GNOME progress, and might change in the future). gentoo build section sounds like it surely should end up in “BUILD.GENTOO” document. GitLab repository sections could be better utilized, like releases or wiki. → agreed, I will work on that.
Do we want to display more application screenshots on homepage or other pages? I’m not a fan of carousels or thumbnail/lightbox solutions. Having one or two screenshots from application inline might be more than enough. → Agreed. One screenshot of the main application window is enough.
Coherent punctuation in lists: either we end all with dot or semicolon or nothing at all, but not a mix of various options. → dots
When to use “code line” (backticks), and when to use “code block” (three backticks block) formatting? Long shell commands does not fit on mobile screens. → If possible, no code at all on the webpage anymore (everything which needs to be kept will be part of the BUILD files in the Gnome Commander repository).
Should we add “copy to clipboard” button to code blocks, as some visitors might expect such feature? → No. See above.

Main page/Index/About

Rephrase “kill bugs” into something more neutral, like “fix issues”. Maybe “bugs” section should be renamed to “Issues” or “Reporting issues?” to match vocabulary used in GitLab. → Great catch. I vote for “Reporting issues”.
Display organization names in donation links, not URLs? Add more? Remove something? → I added those links several years ago, but today I think those links can all be removed.

Download

Add more Linux distributions to pre-built packages: Ubuntu, Slackware? Maybe some more big names are missing? → We should remove all distribution links to reduce maintenance work. Instead, I would like to paste the following (or similar): “Gnome Commander is packaged for most Linux distributions. For installing from source, see the instructions”.

Development

Rename “Development” page to “Contribute”, as there are more ways to contribute than only development. Check Welcome to GNOME – Files for inspiration on how to lay out all the information. Adding section about quality assurance and security testing would be useful. → The development page can be reduced to a very short section on the new homepage of Gnome Commander, where the link to the Git repository is listed. See: the development section on the Meld homepage.
Link current/future plans to appropriate milestones in GitLab? → Yes, a link to GitLab for open features should be added: link.
“current stable” branch number in terminal command quickly gets old. Nobody is going to update this after each release. Some clever workaround is needed here. Or a command line to quickly find latest stable version number. → Just remove this information. If someone want’s to contribute, the maintainer can take care to decide where the changes should go to and/or to add the changes from the main branch to the current stable branch.
Building from source: it would be useful to list what dependencies are required to build project. No need to list every one for each distribution, but some general list. Probably should be moved to repository, along with all technical information. → No need, I believe. This is already listed in the install instructions.
Compendium/compendia? What is the difference? What is correct spelling? → The section “Contributing by translating” can be removed. It was added in the early days when Gnome Commander was translated to only a couple of languages. Now, with the help of the GNOME translation team, everything goes well! They are doing a great job over there, I believe we don’t need to add the information in that section to the new Gnome Commander homepage again.
Update application title and new URL of “Gtranslator” → This can be removed completely as well. (same as above).
Ask someone from translation team to review the “Contributing by Translating” section. Maybe link to official GNOME docs? → Please check the meld homepage for reference. They mention the “Internationalization support” at the bottom of the page, as well as a link to the project translations. We should do similar for Gnome Commander: Gnome Commander at damned lies.

Design and layouts

Do we want to display slogan “A powerful file manager for the GNOME desktop environment” under application title in navigation bar (header)? Or move it to about section and keep header clean? → Lets remove it and keep the header clean.
Is current layout “External packages” looking good? Should we simplify it by making icons larger, so tap targets would be bigger on mobile? Would be nice to keep this part simple and not to go building custom HTML layouts. We could use distribution logos with names inside them. There is always alt text available for accessibility. → as mentioned earlier, this section from the download page can be removed. Actually, the whole download page can be removed. See the meld homepage for reference.
Use 4:3 aspect ratio for screenshots to fit all screens better and showcase more content. → I will create a new screenshot soon.
Dark mode and use application screenshot taken in dark mode in it. → Oh, good idea. Will create one as well.

Final cleanup

After website is complete, update “Updating the Homepage” section. New link to website repository, info how to report issues and create MRs with content changes. → the “Updating the Homepage” section will not be needed anymore if we move to GitLab pages and add the code into the Gnome Commander repository. At least this is my understanding of it? (The current section was needed since the homepage is currently hosted externally on GitHub.)

I’d recommend to link to Welcome to GNOME – Translation instead of wiki. It’s more bare bones, but unlike old wiki it can actually get better

1 Like

Thank you for quick reply. Whole website got distilled into single web page, with most important information intact. Looks neat. I’ve updated website at same URL, might need full reload, if it was cached.

Final stretch to get all content in correct sections, maybe switch some sections around? Although the content flow looks good and logical to me: application name, what it does, how it looks like and where to download it. And all extra information for more curious visitors or potential contributors is available below.

I’ve hidden the “Sample scripts for the file popup menu” as it sounded like it belongs in application documentation or help section.

Looking at Meld website, we should probably add version number and last release date too? Although that sounds like additional maintenance task. So I am not very keen on this idea.

We probably don’t need navigation links in header? Or do you think they might be convenient for the user?

Finally, it looks like, that final version of website can be delivered as simple, hand crafted index.html page, with only few assets along with it. There’s probably no need for using static site generator like Jekyll and fancy build pipeline? Although, having website content in markdown makes it a bit easier to edit in the future and protects it a little bit of formatting errors.

This page is nice. On the other hand, it links to all applications which are GNOME core and circle apps (app’s page)? At the moment, Gnome Commander is none of them, so it might be confusing if we link to the “Welcome to GNOME - Translation” page, and then the Gnome Commander application wont be found there. … I just opened an issue for welcome.gnome.org and asked if Gnome Commander could be added there in the search results.

Update: Indeed…

grafik

Thank you, jushas, I like the new look of the page!

Regarding your questions above:

  • No need to put the current version on the homepage. We can just link to the releases page in GitLab, where the user can find the current version. That’s why we can even merge the Download and Installation sections into one section (“Download and Installation”).
  • The link to older releases can be removed (users are almost always interested in the most recent version).
  • Change “A powerful file manager for the GNOME desktop environment” to “A powerful file manager for the Linux desktop environment” (because Gnome Commander can be used on other window managers, too).
  • I am unsure if the “Authors” section needs to stay, because it hides the numerous contributions to the project by other developers. So I tend to remove it as well.

And right, Jekyll is not needed anymore. It was actually only used for posting articles about new releases. This is not needed now that we have migrated to the GitLab release pipeline.

Is the footer needed? Looks as if it can be removed? Or do you want to put your name there (for the author of the page layout? :slight_smile:

Update: When this is all done, how to go on then? Would you mind opening a pull request for GNOME / gnome-commander · GitLab ?

Made a few minor updates to content according to last comments.

Reverted “GNOME Translation project” link, as it will be confusing, when potential contributors won’t be able to find Gnome Commander among listed apps.

I think “Latest release” link could be a bit bigger than the rest, maybe even a medium sized button to catch attention? Something that will be solved with some custom design element :slight_smile:

Footer should probably contain some generic “copyright” (or copyleft?) message, with year, attributing website ownership to “Gnome Comander team”? No need for anything else there.

For authors: maybe let’s borrow the sentence “Gnome Commander has seen many great developers and contributors since its inception and we thank them all.” and link to AUTHORS in repository?
And I see there is Members · GNOME / gnome-commander · GitLab list on GitLab, not sure how well it represents actual contributors though? We could also move thanks to authors to footer, if that does not seem too disrespectful?

Should we be highlighting that project is using GTK4 and Rust?

As for delivery, are you planing to keep website in main repository, or split it of into “pages” branch, as some other projects (including Meld) are doing? Either way I could create a merge request with all required files, we would set up pipelines and some some final tweaks and adjustments before final merge. Just in case main repository will be used, I need to know directory name, where to place website files.

Hm, the latest release will be at the top in the releases list on GitLab. Don’t know if this is really needed, but you can give it a try. :slight_smile:

Yes. I would prefer the “CC0 1.0" license for the webpage. “Gnome Commander Team” as the author sounds good, and the current year.

:+1:

No, this list is not the list of contributors. Instead it represents all the GNOME GitLab users with access to this repository. They don’t necessarily need to have contributed to the code.

Yes! :slight_smile:

I would prefer the same repo, but in the pages branch. The directory name should be “website”?

Trimmed down even more content and shuffled a few sentences into more appropriate places. I hope I did not remove too much useful information :slight_smile: Preview URL is updated.

By the way, there’s a typo in AUTHORS file in GitLab repository: “contributers” → “contributors”.

Started to do some design work, to get a feel on what final result might look like and mobile layout is a bit broken for now.

I think when website is stored in separate branch (pages) it is not required to be inside any directory?

Oh well, this looks great! Thanks a lot. This is exactly as I would like it to look. If you want you can tweak it a bit, but I am really happy with how it looks right now. … And I will fix the typo you mentioned, thx!

Ah, okay. I did not check in particular how this is done when using a separate branch. But it makes sense, yes.

Updated mobile layout, it should not have any glaring issues on mobile devices right now.

It would be great to get some work in progress screenshot at 4:3 resolution, just to test how higher image will look in main layout. Image will be rendered at maximum 740x555px size, but if necessary, it is possible to make it wider and break out of main column. Also, it is possible to keep smaller thumbnail for quicker loading times, and open much larger image on click. Not sure if this is necessary though. Oh, and if we want to have even sharper looking image for high DPI screens, we should take screenshot of it at twice the size - 1480x1110px. And, if possible, I’d like to get screenshot of application in dark mode, as I still in progress to add dark mode to website.

Finally, I’ll be cleaning up CSS styles and probably create a MR to move it to main repository. Work can continue there.

1 Like

Wow, cool! I will provide some screenshots in one or two days since I was traveling today and will be off until Sunday. Will respond soon. Thanks for the update of the webpage. I just saw the improvements for mobile screens. Great! :clap:

Technically it could cause confusion, but I didn’t heard any such case yet.

My biggest problem with linking to old wiki is:

  1. it’s severely outdated
  2. it’s not particularly good
  3. it cannot be improved since wiki have been archived.

If you want to, please file a bug report about it and I’ll see if I can improve it. I imagine this sentence can be dropped altogether, since it’s meant to be an intoduction to GNOME translation system, with Damned Lies, and there aren’t any differences in modules really. Sophie (reviewer of my initial MR adding it) added that link probably because some apps don’t use DL, but I think it’s their problem, not ours.