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

docs: Enhance web communication and localization #258

Merged
merged 94 commits into from
Sep 13, 2024

Conversation

illavoluntas
Copy link
Contributor

@illavoluntas illavoluntas commented Aug 14, 2024

Describe your changes

This PR creates a brand new HTML frontpage for the website https://dockdoor.net and localizes it (using collaborative translations, Crowdin).

Related issue number(s) and link(s)

Closes #257
Closes #272
Closes #285.

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have followed conventional commit guidelines

Core Functionality Changes

  • This PR does not change core files.

Checklist before merging this PR

  • Mark this PR ready for review

@illavoluntas illavoluntas changed the title Revamp website and localize it docs: Revamp website and localize it Aug 14, 2024
- add fr and he locales blank html
- delete temporary index2.html
- update index.html
- add better quality video demo for keybind set
- remove setKeybind.mov as unused
- Continue progress
- add necessary screenshot resources
- add necessary screen recordings (demos)
- add new design on index2.html
- update styles.css
- add language switching system on index2.html
- fix dropdown menu not hiding on mobile
- fix missing id on dropdown menu
- fix language problems
- fix dropdown menu appearing on hover instead of on click
- add image resources
- add video resources
- update styles.css
- update index2.html
- update styles.css
- remove unnecessary assets files
- add button
- add button class
- add buttons for download
@illavoluntas
Copy link
Contributor Author

Oh, one thing left. Adding DOCS.md (I already made screenshots in https://github.com/illavoluntas/illavoluntas.github.io/tree/main/resources/settings) with a tiny documentation (adding #285 too). After I’m done writing it, I think you should add a question mark button adapted to each tab (maybe not Updates). See #257 (comment)

@illavoluntas
Copy link
Contributor Author

illavoluntas commented Sep 2, 2024

Best thing I can suggest here is creating a dedicated repository for the website. This way you can have a clean workspace for Crowdin.

@ejbills, I think you will have to do that. Plus creating a Crowdin project. This way it also separates the website and the app, and source code archives (when you publish a new release) will still weigh less than 5 MB instead of 20 MB with all these files I added for this PR.

@ejbills
Copy link
Owner

ejbills commented Sep 3, 2024

Best thing I can suggest here is creating a dedicated repository for the website. This way you can have a clean workspace for Crowdin.

@ejbills, I think you will have to do that. Plus creating a Crowdin project. This way it also separates the website and the app, and source code archives (when you publish a new release) will still weigh less than 5 MB instead of 20 MB with all these files I added for this PR.

The site files wouldn't be included in the compiled app.

I'm a bit stuck, if we replace it with a new repo just for the site, I wouldn't be able to use the domain on this repo. Which means, the sparkle updater would be broken as I already switched the domain for this repo. If I switch it back, I'd have to make dockdoor.net forward to dockdoor.kepler.cafe for updates to work, consequentially meaning I wouldn't be able to use dockdoor.net on the other repo.

@illavoluntas
Copy link
Contributor Author

I know the site wouldn’t be included to the final DMG, I meant the source code ZIP and TAR GZ. Contributors would have to get site files when they clone the repo.

As for the updater, I understand your problem. Maybe I will find a way to make Crowdin work only for translation.json (in the website Crowdin project) by modifying parameters in my test project. I tried linking to another file than crowdin.yml, customized, but it failed.

@ShlomoCode
Copy link
Contributor

Maybe we can use a crowdin alternative for the site. I have listed a few in #114.

@ejbills
Copy link
Owner

ejbills commented Sep 3, 2024

Nothing I have seen in the crowdin docs to specify we can't use one, shared crowdin.yml.

See: https://developer.crowdin.com/configuration-file/#ignoring-files-and-directories

We just need to specify a separate project id. However, this is locked into the paid tier of Crowdin. See: https://community.crowdin.com/t/how-to-add-2-different-integrations-for-the-same-project/3289/2

I need to apply for a free open source license.

@illavoluntas
Copy link
Contributor Author

Well, you might want to try.

@ejbills
Copy link
Owner

ejbills commented Sep 6, 2024

I was approved for the open-source license, I need to look into how we can integrate this into the crowdin account. I will get back to you.

@illavoluntas
Copy link
Contributor Author

I was approved for the open-source license, I need to look into how we can integrate this into the crowdin account. I will get back to you.

Nice! Thank you for making the demand!

@illavoluntas
Copy link
Contributor Author

I think the main thing to modify here is crowdin.yml. If you succeed, will it be necessary to create a separate Crowdin project for the website?

@illavoluntas
Copy link
Contributor Author

illavoluntas commented Sep 10, 2024

@ejbills Hi! Any update about it?

@ejbills
Copy link
Owner

ejbills commented Sep 10, 2024

@ejbills Hi! Any update about it?

It's on my roster, I am a bit busy atm. I have this on my mind I promise, I will get to this in the coming days.

@illavoluntas
Copy link
Contributor Author

@ejbills Hi! Any update about it?

It's on my roster, I am a bit busy atm. I have this on my mind I promise, I will get to this in the coming days.

No problem! You don’t have to hurry at all. I’m very busy too and I’m essentially available on weekends… which makes the workflow slower…

@ejbills ejbills marked this pull request as ready for review September 13, 2024 03:49
@ejbills ejbills merged commit 0574e90 into ejbills:main Sep 13, 2024
2 checks passed
@illavoluntas
Copy link
Contributor Author

Well, there were some little adjustments left to be made…But they are minor, so I’ll review them and make a new PR 😉

@ejbills
Copy link
Owner

ejbills commented Sep 13, 2024

@illavoluntas merged! Thanks so much for this wonderful PR. I realize the changes I made recently regarding the default keybind and related options will need to be reflected in the README and FAQ sections (now defaults to option tab). I will do this tomorrow if I have some time.

@illavoluntas
Copy link
Contributor Author

You’re welcome! What about Crowdin? The old link (my project) is still on README…

@illavoluntas
Copy link
Contributor Author

illavoluntas commented Sep 13, 2024

Also, could my work be please mentioned on the next release?
You finally may want to add the website link to the description field on https://github.com/ejbills/DockDoor. See https://stackoverflow.com/questions/67217281/adding-github-pages-url-to-github-repositorys-about-section

@ejbills
Copy link
Owner

ejbills commented Sep 13, 2024

Also, could my work be please mentioned on the next release?

Of course 😁

I fixed the readme crowdin link and added the github pages link to the sidebar

@illavoluntas
Copy link
Contributor Author

@ejbills Could you remove the / after the website link?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants