giellalt / giellalt.github.io Goto Github PK

Hi,
There is probably a syntax problem with the following page : https://giellalt.github.io/lang/common/developingwork.html
In the "Impressionistic testing" section, the code appears as text, and the text as code…
Thanks for these amazing tools,
JP

To repeat: Go to In-source documentation for any language model, e.g. https://giellalt.github.io/lang-smn/ . The affixes and stems catalogues are not expandable, and the files under them thus inaccessible.

We want maturity badges in places where they are presently manually maintained:

• README's
• GitHub Pages

Now that we have worked out how to get repo lists based on maturity topic labels, it would be very ok to also have badges based on the same data, so that we essentially only have one source of truth.

https://shields.io has support for dynamic badges. It can take json data as input. The following is a suggestion by @bbqsrc:

• publish a json file in your github pages & use that as the endpoint
• set the url= part to your github pages published json file
• maturity.json or something
• query=$.whatever_id

That should be enough.

There are cases where it does not make sense to filter repos based on tags. We need to update

this to test for an empty or null filter, and in that case allow all repos to be added.

See https://github.com/github-tools/github for a likely candidate to interact with the GitHub API from Javascript.

The idea is to create lists of names and links to repos, based on pattern matching against repo name and optionally topic labels. That is, something like:

• give me all repos with names matching the regex lang-* and with a topic matching maturity:production
• return the list, and format it as a standard HTML UL, with a link to each repo's github.io site, and the visible URL text should be the autonym (possibly with the English name as a tooltip)

Given that we presently have 134 language repos and more than 50 keyboard repos — and more is expected to be added — this is the only sane way to maintain a complete overview of all the language resources available.

Tasks:

• implement dynamic list functionality
• make it possible to link to the github repo instead of github.io (for the whole class of matching repos)
• filter on maturity topic label, also on absense of such a topic label
• filter on arbitrary topic label
• add autonym to link text

Many linux keyboard layouts are managed using freedesktop https://www.freedesktop.org/wiki/Software/XKeyboardConfig/
For Norwegian, see https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/blob/master/symbols/no

Would a pull request mentioning this be welcome?

Using a resource like https://leafletjs.com it should be possible to:

• map language ISO codes to area codes (country or subdivisions thereof) - glottolog is one possible source
  • we should include all resources: language models, keyboards, corpora, anything with a language code and a repo in github
• use area codes with leafletjs to highlight the area for a language
• display a map view of where the languages are located that we have in our repository

Not important, but it would be a nice touch to our documentation 😄

The present Jekyll theme has several shortcomings:

• no sitemap/overview of available pages
• the page TOC to the left is really a hack
• does not play well with smaller screen sizes
• no dark mode
• not easily exentable
• inline code is not clearly separated from the surrounding text
• search results are still lousy

What is good about it is:

• mostly good layout and typography = easy to read
• relatively modern design

I would thus like to replace the current theme with something else. The requirement are:

• Page TOC
• Site map/view
• builtin support for Mermaid, math (not important), charts (=no hacks to make it work)
• responsive design
• light and dark mode, both manual and automatic (= follows system)
• easily extendable in config file or document config headers
• better code & syntax formatting
• preferably active community & development work
• anonymised analytics
• better search

Some candidates:

• https://kitian616.github.io/jekyll-TeXt-theme/
• https://just-the-docs.github.io/just-the-docs/

This issue is filed under giellalt.github.io, and obviously applies to that site. In addition it should also apply to most subsites (all language models, keyboard repos, dictionary repos, etc).

I am not too happy about the candidates, but they are so far the best I have found. Do you have any better suggestions @albbas and @flammie and @Phaqui ?

Instead of having to manually maintain license badges for 200+ repositories, we want to display the correct badge based on the actual license info. See:

https://docs.github.com/en/rest/reference/licenses#get-the-license-for-a-repository

This holds for README's and GitHub Pages, as well as dynamic repository lists.

Badges generated by shields.io

This way there will only be one source of truth, and that is the LICENSE file itself.

The Jekyll plugin jekyll-spaceship can improve several aspects of the GitHub Pages documentation:

• flow charts and other diagrams from a simple text syntax
• more flexible tables
• graphs & pie charts from textual data
• and more

Unfortunately, it is not supported by default by GitHub Pages, and making it work is a bit of a hassle. I have looked at the following:

• https://github.com/jeffreytse/jekyll-jeffreytse-blog/blob/master/Gemfile
• https://www.moncefbelyamani.com/making-github-pages-work-with-latest-jekyll/
• https://jekyllrb.com/docs/plugins/installation/
• https://github.com/limjh16/jekyll-action-ts

I have so far tested with lang-smn. When it works, the following test page should be rendered as a simple graph:

• https://giellalt.github.io/lang-smn/Test.html

Ingen av linkene til språkdokumentasjonen peker til eksisterende sider, f.eks. https://giellalt.github.io/lang/sme/j-sme.html gir 404

When searching the documentation using the Google search bar, I often do not find anything, although what I am looking for exists in the documentation.

For example searching for environment variables site:https://giellalt.github.io/ returns nothing. This works searching the old site. Using the same example environment variables site:https://giellalt.uit.no/ yields the results I was looking for.