Installation documentation

[NTDLS]

Create installation documentation for the website and the database.

[NTDLS]

Partially complete, we now have this for windows: https://tightwiki.com/wiki_help::installation

[NTDLS]

Also created youtube video for installing on windows:
https://www.youtube.com/watch?v=4YIo7K7Yq5A

[maidis]

Do you think it would be a good idea to generalize this issue for documentation requests?

How do I update the software version?
Are there things to consider to avoid losing data in the database?

How can I contribute to the translation?
What tools can be used? What should be kept in mind when translating? How are translations submitted to the project?

[NTDLS]

I do think this should be documented! I will document it, and I'll answer some of them here for now.

• Q: How do I update the software version? Are there things to consider to avoid losing data in the database?
• A: The release zip files contain two directories, "site" and "data. Replace the "site" files, but do not overwrite your appsettings.json or web.config.
• A: Additionally, DO NOT replace your "data" files at all. The site will upgrade your existing databases when the site started.

Q: How can I contribute to the translation?
Q: How are translations submitted to the project?
A: I am considering writing a simple site to browse the translations and submit suggestions.

Q: What tools can be used?
A: Right now, I am using OpenAI gpt-4o-mini to automate the translation. I know they are imperfect to say the least.

Q: What should be kept in mind when translating?
A: That the translations are per view, page, and controller. So if you find a translation that needs to be fixed - it likely needs to be fixed in several places. For common phrases, that can be dozens or hundreds of places.

[maidis]

• A: Additionally, DO NOT replace your "data" files at all. The site will upgrade your existing databases when the site started.

Does this apply to this situation as well? I mean, when new columns are added to the tables in the database?

49a9ee1

[NTDLS]

Yep. The website itself contains a database initialization directory which contains versioned scripts. When your running version is not equal to the version in the configuration database, it steps through every version from the one in the config database to the one you are upgrading to, and will bring your database up to the current version.

This folder can be found in the repository project and is baked into the compiled binaries. For safety, there is also a convention in the top of each script to only attempt to create columns when they do not exist. This also applies to table and index creation.

https://github.com/NTDLS/TightWiki/tree/main/TightWiki.Repository/Scripts/Initialization/Versions

[NTDLS]

Created some quick documentation on the upgrade process: https://tightwiki.com/wiki_help::upgrade

[maidis]

Thank you for the new release.

We switched to the pre-release version this morning. Are there any specific considerations when upgrading from the pre-release version to the release version itself?

Or can we follow the standard update procedure directly?

[NTDLS]

Its just a standard upgrade, I always bump the version for the full releases anyway.

Also, thank you for the new function suggestions - I've been out of ideas for a while!! 🗡️

I don't know if you were aware, but you have been an admin on TightWiki.com for a while. Feel free to login, look around, and test stuff before each upgrade.