KEMBAR78
Porting Switch2OSM to MkDocs from Jekyll by Andygol · Pull Request #244 · switch2osm/switch2osm · GitHub
Skip to content

Conversation

@Andygol
Copy link
Contributor

@Andygol Andygol commented Oct 14, 2023

This PR closes #224.

If necessary, the translation of texts can be organized through the integration with Transifex (use transifex.yml)

Feel free to adjust this PR if needed.

Andygol and others added 30 commits April 2, 2023 13:54
- typo
- css for main page moved to external css
100% translated for the source file 'docs/en/en.yml'
on the 'uk' language.
…3e28e704fc94_uk

Translate 'docs/en/en.yml' in 'uk'
100% translated for the source file 'docs/en/other-uses.md'
on the 'uk' language.
100% translated for the source file 'docs/en/other-uses.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-18-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-22-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-22-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-22-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-22-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/manually-building-a-tile-server-ubuntu-22-04-lts.md'
on the 'uk' language.
100% translated for the source file 'docs/en/serving-tiles/updating-as-people-edit-osm2pgsql-replication.md'
on the 'uk' language.
transifex-integration bot and others added 12 commits October 9, 2023 13:03
100% translated source file: 'manually-building-a-tile-server-debian-12.md'
on 'uk'.
…52508b63a5f7_uk

Updates for project Switch2OSM and lanuage uk on branch main
100% translated source file: 'docs/en/en.yml'
on 'uk'.
100% translated source file: 'docs/en/en.yml'
on 'zh_TW'.
100% translated source file: 'monitoring-using-munin.md'
on 'uk'.
100% translated source file: 'index.md'
on 'uk'.
100% translated source file: 'docs/en/using-tiles/index.md'
on 'uk'.
…52508b63a5f7_zh_TW

Updates for project Switch2OSM and lanuage zh_TW on branch main
…52508b63a5f7_uk

Updates for project Switch2OSM and lanuage uk on branch main
@pnorman
Copy link
Contributor

pnorman commented Oct 15, 2023

This has hundreds of commits and file changes. I'm not sure how this is reviewable.

A PR should do one thing. I recommend doing one PR for changing to Jekyll, if that's what we want to do, another PR to add translation support, and then any translations can be added in the mechanism we decide for them.

@Andygol
Copy link
Contributor Author

Andygol commented Oct 15, 2023

To be honest, I'm a little confused by this answer. The offer to switch to MkDocs with a working example has been around for half a year. Since its introduction, it has only been mentioned that a pull request is needed, but it is not clear who should do it.

On my part, this PR was an attempt to move the issue from its current state of limbo.

It is worth noting the help from @Firefishy in creating github actions for building a container with a working site (Andygol/switch2osm-mkdocs#37). So, by and large, it is enough just to replace one container with another one used for the main site, for the changes to take effect.

I also don't think this PR is a perfect solution, but I can suggest the following transition plan:

  • The switch2osm repo in its current state (jekyll version) is archived and renamed to preserve historical artifacts.
  • Forking (or copying content) from https://github.com/Andygol/switch2osm-mkdocs to https://github.com/switch2osm/switch2osm. This can be either one big commit or multiple commits split into stages, as described in the comment above. (Personally, I'm more inclined towards one global commit).
  • Appropriate changes are made to the mkdocs.yml file to reflect the current repo
  • Integration with Transifex is being configured to support translations in other languages. At https://app.transifex.com/openstreetmap/ a corresponding project is created for this. If necessary, it can be any other website that offers similar services.

@Firefishy
Copy link
Contributor

@Andygol The work to move it to mkdocs looks excellent to me. I contact the other contributors of the site to get agreement, if I get agreement I will push this live.

@SomeoneElseOSM
Copy link
Contributor

I'm sure that I commented somewhere on this with something like "I'd love to see it available in other languages, but can't really comment on potential issues with mkdocs vs Jekyll" but can't see where I said that.

If mkdocs content is about as easy to edit and test as jekyll content, then I'd have no objections. Preferably for me it wouldn't require Yet Another Package Manager, but mkdocs looks promising.

dependabot bot and others added 6 commits October 16, 2023 03:23
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.4.4 to 9.4.6.
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.4.4...9.4.6)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [mkdocs-static-i18n](https://github.com/ultrabug/mkdocs-static-i18n) from 1.1.0 to 1.1.1.
- [Changelog](https://github.com/ultrabug/mkdocs-static-i18n/blob/main/docs/changelog.md)
- [Commits](ultrabug/mkdocs-static-i18n@1.1.0...1.1.1)

---
updated-dependencies:
- dependency-name: mkdocs-static-i18n
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
…-1.1.1

Bump mkdocs-static-i18n from 1.1.0 to 1.1.1
@Andygol
Copy link
Contributor Author

Andygol commented Nov 6, 2023

@Firefishy could you reopen the PR.

Something goes wrong when I pushed updates to the fork 😞

@Firefishy
Copy link
Contributor

@Andygol "branch has no history in common with switch2osm:master". It will not let me re-open.

@Andygol
Copy link
Contributor Author

Andygol commented Nov 6, 2023

Looks like I need to do a new PR

Andygol referenced this pull request in Andygol/switch2osm.github.io Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implementation of the multilanguage support for Switch2OSM.

4 participants