Upload Order - LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE GitHub Wiki

Порядок загрузки файлов в GitHub Wiki

Home · BASIC · UO API · A–Z · Examples · Languages

Самый правильный способ

GitHub Wiki хранится в отдельном репозитории OWNER/REPOSITORY.wiki.git. При загрузке через Git порядок копирования не влияет на результат: все .md и папку images можно добавить одним commit. Но первая страница Home.md должна уже существовать, чтобы GitHub создал Wiki-репозиторий.

Для репозитория LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE уже подготовлен файл UPLOAD_TO_GITHUB_WIKI.cmd. После создания первой страницы Home достаточно запустить его двойным нажатием.

Пошагово

1. Включить Wiki

  1. Откройте основной репозиторий GitHub.
  2. Перейдите в Settings → General → Features.
  3. Включите Wikis.
  4. Откройте вкладку Wiki.
  5. Создайте первую страницу с названием Home.

2. Загрузить основные страницы

Загружайте в таком порядке:

  1. Home.md
  2. Languages.md
  3. About-the-Project.md
  4. Installation.md
  5. Editions-and-Package-Layout.md
  6. Bad-Newbie-Features.md
  7. Typography-and-Fonts.md
  8. Hover-Cards-and-Info-Bar.md
  9. Cast-Indicators-and-Movement.md
  10. Localization.md
  11. Settings-and-Profiles.md
  12. Basic IDE-Runtime.md
  13. Basic IDE.md
  14. Scripting-Quick-Start.md
  15. AutoLoad-and-Macros.md
  16. API-Manual-and-Inspector.md
  17. Age-of-Power.md
  18. Age-of-Power-Console-Commands.md
  19. Age-of-Power-Quests.md
  20. Age-of-Power-Quest-Archive.md
  21. Age-of-Power-Crafting.md
  22. Age-of-Power-Crafting-Armor.md
  23. Age-of-Power-Crafting-Weapons.md
  24. Age-of-Power-Crafting-Carpentry.md
  25. Age-of-Power-Crafting-Tinkering.md
  26. Age-of-Power-Crafting-Consumables.md
  27. Age-of-Power-Resources.md
  28. Project-Architecture.md
  29. Build-from-Source.md
  30. Testing-and-Verification.md
  31. Troubleshooting.md
  32. FAQ.md
  33. Security-and-Server-Rules.md
  34. Release-Notes.md
  35. Publishing-the-Wiki.md
  36. Upload-Order.md
  37. Runtime-API-Manual.md, Runtime-API-Alphabetical-Index.md, Runtime-API-Audit.md и все Runtime-API-??-*.md

После страниц загрузите папку images целиком, сохраняя её имя и имена файлов.

3. Загрузить языковые страницы

Для каждого языка сначала загрузите обзорную страницу Manual-CODE.md, а затем тематические страницы этого же кода.

Порядок языков:

  1. Manual-EU.md и все EU-*.md
  2. Manual-RU.md — русский обзор; подробная русская Wiki начинается с Home.md
  3. Manual-UA.md и все UA-*.md
  4. Manual-FR.md и все FR-*.md
  5. Manual-DE.md и все DE-*.md
  6. Manual-IT.md и все IT-*.md
  7. Manual-ES.md и все ES-*.md
  8. Manual-ZH.md и все ZH-*.md
  9. Manual-JA.md и все JA-*.md
  10. Manual-KO.md и все KO-*.md

Внутри каждого языка рекомендуемый порядок:

  1. CODE-Installation.md
  2. CODE-Bad-Newbie.md
  3. CODE-Basic.md
  4. CODE-AutoLoad.md
  5. CODE-API-Manual.md
  6. CODE-Build-and-Testing.md
  7. CODE-Troubleshooting.md

4. Служебные файлы загружать последними

  1. _Sidebar.md
  2. _Footer.md

README.md в Wiki загружать необязательно: он нужен прежде всего как инструкция внутри подготовленного локального комплекта.

Загрузка всех файлов через Git

После создания первой страницы Home:

git clone https://github.com/OWNER/REPOSITORY.wiki.git
Copy-Item .\ClassicUO-GitHub-Wiki\*.md .\REPOSITORY.wiki\
New-Item -ItemType Directory -Path .\REPOSITORY.wiki\images -Force | Out-Null
Copy-Item .\ClassicUO-GitHub-Wiki\images\* .\REPOSITORY.wiki\images\ -Recurse -Force
cd .\REPOSITORY.wiki
git add .
git commit -m "Add ClassicUO Wiki"
git push

При этом способе вручную соблюдать порядок файлов не требуется. GitHub сам использует Home.md как главную страницу, _Sidebar.md как боковое меню и _Footer.md как нижнюю часть страниц.

Что не загружать в Wiki

  • ClassicUO-GitHub-Wiki.zip;
  • .sha256.txt;
  • клиент и исполняемые файлы;
  • исходники проекта;
  • игровые данные Ultima Online;
  • личные профили, пароли, настройки и журналы.

ZIP и его SHA-256 следует прикладывать к GitHub Release или хранить отдельно, а в Wiki загружаются .md и папка images.