developer-portal/website

Jekyll templates, CSS styles and images for the Fedora Developer Portal.

website's Issues

Document release process

Links from search stopped working

They have content/ part in their URL.

@asamalik I suspect this happened with the latest deploy.

Use only setup.sh in OpenShift assemble script

User in OpenShift container doesn't have permission to run dnf install
This can be temporarily resolved by using Gemfile and pip

the link of "Torrent Downloads" should be replaced to the link of "Alternative Downloads"

In footter of webpages, there is "Torrent Downloads" in "Download" column, but this link should be replaced to "Alternative Downloads" .
https://alt.fedoraproject.org/en/

Because "Alternative Downloads" incledes the link of torrent downloads.

Add subsection image for Virtualization inside the Tools section

I am trying to introduce a new subsection with the PR developer-portal/content#394 but it cannot be merged yet as the subsection does not have a logo.

Noting that the section that I am talking about here was newly introduced by me with this pull request. Here's the log.

podman run -it --rm -p 4000:4000 -v "$PWD:/opt/developerportal/website/content:Z" quay.io/developer-portal/devel

Configuration file: /opt/developerportal/website/_config.yml
            Source: /opt/developerportal/website
       Destination: /opt/developerportal/website/_site
 Incremental build: enabled
      Generating... 
       Git authors: Generating authors...
Traceback (most recent call last):
  File "/opt/developerportal/website/rss.py", line 23, in <module>
    feedparser._HTMLSanitizer.unacceptable_elements_with_end_tag.add('<div>')
AttributeError: module 'feedparser' has no attribute '_HTMLSanitizer'
                    done in 6.125 seconds.
 Auto-regeneration: enabled for '/opt/developerportal/website'
LiveReload address: http://0.0.0.0:35729
    Server address: http://0.0.0.0:4000/
  Server running... press ctrl-c to stop.
[2021-09-08 02:14:07] ERROR `/static/logo/virtualization.png' not found.
[2021-09-08 02:14:14] ERROR `/static/logo/virtualization.png' not found.
[2021-09-08 02:14:22] ERROR `/static/logo/virtualization.png' not found.

Fedora Developer Portal package

It'll be great to have Fedora Developer Portal packaged as application in Fedora.
There is long way to go and I'll try to track progress in this issue.

If you interested, here is really early version: https://github.com/frantisekz/content/releases/download/temp/fedora-developer-portal-0.0.1-1.x86_64.rpm
(Can be launched with fedora-developer-portal command)

Before we can try to get this reviewed and included in Fedora repositories we need to have Electron packaged in Fedora. I'll update this package from time to time and I'll try to setup copr repository with this during next week.

Website takes too long to load

The homepage of website took total of 48.87 seconds to load and downloaded 3.2 MB. It is mostly a static website, it shouldn't really use that much data (or time).
Some of the easy wins I can think are:

• compress and optimize title_front.png

  currently 1.9 MB and should not be more than 100KB after optimization for web.

• jquery.dataTables.js is not minified (~$400KB)

• index.json file is too big (~500KB)

  Since the project is still in development, json file will most like keep growing. It would best to devide the data in multiple files and load only relevant data.

Someone please look into this if I don't send a PR soon enough.

Update favicon and Developer Portal logo to use the new Fedora logo.

After Fedora changed its logo, Fedora Developer Portal remained with the older one.

It would be nice if the favicon and relevant files in website/static (mostly named as logo*.*) were updated to use the new Fedora logo.

h2 and h3 look the same

The size and style of both the h2 and h3 tags look the same, maybe it would be better to decrease the h3 font size

Upgrade Google Analytics

https://support.google.com/analytics/answer/9744165

Resolve developers.fedoraproject.org in addition to developer.fedoraproject.org

Sites vary in whether they put their developer portals at "developer.domain" or "developers.domain", making it difficult to remember which sites use the plural form and which don't.

Red Hat put their portal at developers.redhat.com, with developer.redhat.com as an alias.

The Fedora portal is at developer.fedoraproject.org, but developers.fedoraproject.org doesn't exist in DNS.

It would be helpful if the latter domain resolved as an alias for the Fedora Developer Portal.

Hidden text issue in mobile view

In mobile view some text are hidden in divs. I tried to correct it by changing css files. But i failed to correct it. Then i write some javascript code to detect screen width of the browser and change the layout according to it. Any other solution?

h3 headlines are more prominent than h2

See https://developer.fedoraproject.org/tools/vagrant/vagrant-plugins.html

It seems that h2 does not appear as more significant than h3.

Dockerfile will not build

Because content is no .git repository.

• Possibly missing VOLUME in Dockerfile
• Make build non-failing in case content is not a git repository.

https://hub.docker.com/r/developerportal/devel/builds/

[github issues] Add page section to template URL

By appending the values for subdirectory in _config.yml .

If we would want to be more fine-grained, we should be able to do that also via _config.yml by just appending the values for the specific subdirectory.

Originally posted by @pvalena in #140 (comment)

Reference from website to github

It would be good to have a reference from each page to GitHub
so that user can easily update page and made PR.

Bad CSS in empty subsections

There should be more space under the 'Edit this page' button

RPM logo could not be found

https://developer.fedoraproject.org/static/logo/rpm.png

Referenced from:
https://developer.fedoraproject.org/deployment.html

Although it exists:
https://github.com/developer-portal/website/blob/master/static/logo/rpm.png

Probably some jekyll build / distribution issue.

Section image in the tools section does not show its source

https://developer.fedoraproject.org/tools.html

Actual state:

Desired state:

Search does not work

Trying to search content that is for sure on the portal (KW: mariadb, mysql, postgresql), I get no results:
https://developer.fedoraproject.org/search.html?q=mysql

404 when clicking on a link from search result

Links on search result page are broken, see for example here.

Explore alternative header

d21bba3

Use HiDPI logos

Especially the main logo and DevAssistant on the homepage. They should have twice the resolution we show.

It now displays blurry on machines like ThinkPad X1Carbon, MacBook Pro or workstations using 4K monitors in HiDPI mode.

No search is available or functional for Fedora Developer Portal.

There used to be a search field via jekyll-lunr-js-search gem, but that was broken by something. As a result, it was removed in 0889a38

There is a new fork that seems to some point actively supported: https://github.com/dnoneill/jekyll-lunr-js-custom-search , but I had problems integrating it with current setup: #104 (comment) .

Improve build process

The generated website in _site should not contain content/ directory nor files that are not used.

Link back to the Content repo from each page

We should link back to the Content repo from each page to attract contributors.

"Report an issue" button link broken for subpages.

When a user clicks "Report an issue" on the main page of a given topic, the user is taken to Github issues with the correct title (e.g., from https://developer.fedoraproject.org/tech/languages/go/go-installation.html the button link is valid)

However, when a user clicks on the button on the subpage of a topic, the section is not present (e.g., https://developer.fedoraproject.org/tech/languages/go/go-packages.html)
Examples of the bug are:

• developer-portal/content#401
• developer-portal/content#398

One solution would be to parse the link if the required section info is not present in the subpages.

Generate sitemap.xml

RSS feed sources

We should decide what featured blog posts we want.

I suggest:

• the two featured blog posts to be from the Red Hat developer blog
• the four featured blog posts underneath to be from Fedora Planet (as currently implemented)

Ideas? @asamalik @phracek

search.html is in old format

Use newer syntax, as {{#entries)} is not valid anymore.

$ jekyll build
Configuration file: /home/vagrant/Work/RH/devel/FDP/website/_config.yml
            Source: /home/vagrant/Work/RH/devel/FDP/website
       Destination: /home/vagrant/Work/RH/devel/FDP/website/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
              Lunr: Creating search index...
              Lunr: Index ready (lunr.js v0.7.2)
    Liquid Warning: Liquid syntax error (line 19): Unexpected character # in "{{#entries}}" in search.html
    Liquid Warning: Liquid syntax error (line 25): Unexpected character / in "{{/entries}}" in search.html
                    done in 43.062 seconds.

Jekyll permission error in Docker container

Hello.

I want to contribute to fedora developers portal and I want to check my changes before I make a pull request so I decided to install development version to my local machine in docker container.

When I run:

$ sudo docker run -it --rm developerportal/devel

Everything is ok. But when I want to use my own copy of content repository as volume:

$ sudo docker run -it --rm -v ~/Projects/content:/opt/developerportal/website/content developerportal/devel

I got error message from Jekyll:

jekyll 3.0.0.pre.beta10 | Error: Permission denied @ dir_initialize - .

This is my first experience with Docker and Jekyll so I don't know what can be wrong.

Could you please help me?

Set logo max-width

E.g.
https://developer.stg.fedoraproject.org/tech.html

The Redis logo f.e..

Translations

Would have any chance of translations into other languages?

CSS bug in the Deploy and distribute section

There should be a bigger gap:

Probably same size as here:

C# logo is too small

https://developer.fedoraproject.org/tech.html

Migrate content to docs/quick-docs?

I'd filed this in the content repo, but this seems like a better place. (developer-portal/content#349)

Hi there,

Given that docs is now up and running, should the dev portal just be merged into them?

https://docs.fedoraproject.org/en-US/docs/

That way there's one place for users to find documentation, and all of docs can be translated etc too. A lot of the material on here seems like it'd fit right in with quick-docs for example:

https://docs.fedoraproject.org/en-US/quick-docs/

the link "About Fedora" is wrong.

Even if I click "About Fedora" , the page of the "Sponsors" will be displayed. The link is wrong.

Authors are not `optically` separated from page content

Put a line (<hr/>) above the Authors: ..., or some other way(CSS?). Example:

---

https://developer.stg.fedoraproject.org/start/sw/cli-app/about.html

Staging environment for content pull requests in OpenShift

Instead of checking locally via manual docker, it would be possible to have a GH action that would call to an OpenShift instance to deploy a temporary container to check PRs.

Do not use "banner" in css

Some adblocks hide our main title.

Edit button => Edit page

Point Edit this page button directly to /edit/ instead of /blob/

f.e.:
https://github.com/developer-portal/content/edit/master/tech/languages/rust/format-rust-code.md

Add section on Toolbox and podman

First there ought to be a topic called containers where Docker is one of the possible tools.
Then maybe this article could be a good starting point.

https://fedoramagazine.org/a-quick-introduction-to-toolbox-on-fedora/

Mobile view

The main menu do not display correctly on small screens. The front page banner should have smaller padding as well.

MongoDB is missing an image

probably could use https://en.wikipedia.org/wiki/File:MongoDB-Logo.svg.

Why .gitignore don't have the .jekyll-cache on it?

This folder only contains cache from the execution so it could easily be on the .gitignore to avoid generate change refs and possibly cause some build to fail or anything alike.

Mention contributors on respective pages

Let's give credit to our contributors!

Could we for example run 'git blame' during build and get a list of contributors for each page?

We could then put the names (top 5 or all?) on every page.

@pvalena as you were interested in the automated deployment of our testing instance, do you want to have a look at that?

Update Dockerfile to newer Fedora

Also, use setup.sh for building.

Web Applications page has no content

The page needs some basic content.

Authors are duplicated

on Vagrant page.