diff --git a/.github/workflows/build-validation.yml b/.github/workflows/build-validation.yml new file mode 100644 index 0000000..1125aa7 --- /dev/null +++ b/.github/workflows/build-validation.yml @@ -0,0 +1,47 @@ +name: Strict Build Validation + +on: + pull_request_target: + types: [opened, ready_for_review] + +jobs: + validate: + # Prevent running this on forks + if: github.repository_owner == 'heavy-division' + runs-on: ubuntu-latest + steps: + - name: Get PR SHA + id: sha + uses: actions/github-script@v5 + with: + result-encoding: string + script: | + const { owner, repo, number } = context.issue; + const pr = await github.rest.pulls.get({ + owner, + repo, + pull_number: number, + }); + return pr.data.head.sha + - uses: actions/checkout@v2 + with: + ref: ${{ steps.sha.outputs.result }} + fetch-depth: 0 + - name: Make Build + uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: | + pip install -r requirements.txt + mkdocs build -s + - name: Message failure + if: ${{ failure() }} + uses: actions/github-script@v5 + with: + script: | + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: 'Strict Build Failed! ❌ - Please checkout this PR locally to fix the issue before merging or see checks.', + }); \ No newline at end of file diff --git a/.github/workflows/issue-labeler.yml b/.github/workflows/issue-labeler.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/workflows/pr-labeler.yml b/.github/workflows/pr-labeler.yml new file mode 100644 index 0000000..16a13e1 --- /dev/null +++ b/.github/workflows/pr-labeler.yml @@ -0,0 +1,13 @@ +name: "Pull Request Labeler" +on: + pull_request_target: + types: [opened, reopened, ready_for_review, edited] + +jobs: + triage: + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@v3 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + configuration-path: .github/labeler.yml \ No newline at end of file diff --git a/.gitignore b/.gitignore index a1c2a23..4fb49eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +/.idea/ +/site/ +/.cache/ + # Compiled class file *.class @@ -21,3 +25,4 @@ # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* + diff --git a/_config.yml b/_config.yml deleted file mode 100644 index f76be03..0000000 --- a/_config.yml +++ /dev/null @@ -1,14 +0,0 @@ -title: docs -email: contact@hdsimulations.com -description: > # this means to ignore newlines until "baseurl:" - Write an awesome description for your new site here. You can edit this - line in _config.yml. It will appear in your document head meta (for - Google search results) and in your feed.xml site description. -baseurl: "/docs" # the subpath of your site, e.g. /blog/ -url: "https://heavy-division.github.io" # the base hostname & protocol for your site -twitter_username: heavydivsim -github_username: Heavy-Division - -# Build settings -markdown: GFM -permalink: /:year/:title:output_ext \ No newline at end of file diff --git a/docs/B78XH/.pages b/docs/B78XH/.pages deleted file mode 100644 index d5bc968..0000000 --- a/docs/B78XH/.pages +++ /dev/null @@ -1,15 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Heavy Division B78XH -nav: - - Overview: index.md - - Common Questions: faq.md - - b78xh-versions.md - - installation.md - - settings.md - - liveries.md - - support - - Feature Guides: feature-guides diff --git a/docs/B78XH/faq.md b/docs/B78XH/faq.md deleted file mode 100644 index 2f0370d..0000000 --- a/docs/B78XH/faq.md +++ /dev/null @@ -1 +0,0 @@ -# Add the FAQ here diff --git a/docs/B78XH/mod_dev_restrictions b/docs/B78XH/mod_dev_restrictions.mdx similarity index 100% rename from docs/B78XH/mod_dev_restrictions rename to docs/B78XH/mod_dev_restrictions.mdx diff --git a/docs/B78XH/support/.pages b/docs/B78XH/support/.pages deleted file mode 100644 index 675e3b9..0000000 --- a/docs/B78XH/support/.pages +++ /dev/null @@ -1,11 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Support -nav: - - Support Guide: index.md - - reported-issues.md - - performance-tips.md - - ... \ No newline at end of file diff --git a/docs/B78XH/support/guide.md b/docs/B78XH/support/guide.mdx similarity index 100% rename from docs/B78XH/support/guide.md rename to docs/B78XH/support/guide.mdx diff --git a/docs/B78XH/support/reported-issues.md b/docs/B78XH/support/reported-issues.mdx similarity index 100% rename from docs/B78XH/support/reported-issues.md rename to docs/B78XH/support/reported-issues.mdx diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..09ef07a --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +docs.hdsimulations.com \ No newline at end of file diff --git a/docs/assets/flaps.PNG b/docs/assets/flaps.PNG new file mode 100644 index 0000000..6bb6ba7 Binary files /dev/null and b/docs/assets/flaps.PNG differ diff --git a/docs/assets/fmc_preflight_complete.PNG b/docs/assets/fmc_preflight_complete.PNG new file mode 100644 index 0000000..76e7b5a Binary files /dev/null and b/docs/assets/fmc_preflight_complete.PNG differ diff --git a/docs/developers/dev-support.md b/docs/developers/dev-support.mdx similarity index 100% rename from docs/developers/dev-support.md rename to docs/developers/dev-support.mdx diff --git a/docs/developers/development-projects/documentation.md b/docs/developers/development-projects/documentation.mdx similarity index 100% rename from docs/developers/development-projects/documentation.md rename to docs/developers/development-projects/documentation.mdx diff --git a/docs/developers/quality_assurance/qa_onboarding.md b/docs/developers/quality_assurance/qa_onboarding.mdx similarity index 100% rename from docs/developers/quality_assurance/qa_onboarding.md rename to docs/developers/quality_assurance/qa_onboarding.mdx diff --git a/docs/faq.mdx b/docs/faq.mdx new file mode 100644 index 0000000..9835032 --- /dev/null +++ b/docs/faq.mdx @@ -0,0 +1,22 @@ +# FAQ + +### Where is the plane in the hangar? +The B78XH is a modification of the default premium deluxe aircraft, you need to own the premium deluxe version of MSFS to use the Heavy Division Mod. + +### Where can I download the B78XH addon? +You can download the Stable, Development and Experimental builds from our [discord]() or [website]() You can also download the addon directly from the GitHub Repository to install manually. + +### When is the Next Update? +We don't know when the next update will be, however you can keep up to date with development by checking our [updates broadcast]() channel in Discord. + +### How do I join the team? +You can send an application to our [Google Form,]() and we'll try to get back to you as soon as possible if you're a good fit for the role. + +### Does the Mod cost money? +No, it is completely free and open-source. + +### Where do we report bugs? +Please submit bug reports as [issues]() using our GitHub issue-ticket system. + +### I am a real life Aero Engineer, GA, B787-8/9/10 Pilot, or Cabin Crew. Where do I get my role? +Simply DM one of our staff on Discord with proof of your job! \ No newline at end of file diff --git a/docs/index.mdx b/docs/index.mdx new file mode 100644 index 0000000..e69de29 diff --git a/docs/B78XH/liveries.md b/docs/liveries.mdx similarity index 100% rename from docs/B78XH/liveries.md rename to docs/liveries.mdx diff --git a/docs/pilots-corner/beginner-guide/.pages b/docs/pilots-corner/beginner-guide/.pages deleted file mode 100644 index 781292e..0000000 --- a/docs/pilots-corner/beginner-guide/.pages +++ /dev/null @@ -1,17 +0,0 @@ -# Edit this page to get: -# - Title for the whole directory -# - Titles for specific pages or subdirectories -# - Order of pages (otherwise alphabetical order) - -title: Beginner Guide -nav: - - Overview: overview.md - - preflight.md - - starting-the-aircraft.md - - preparing-cdu.md - - engine-start-taxi.md - - takeoff-climb-cruise.md - - descent.md - - landing.md - - after-landing.md - - powering-down.md \ No newline at end of file diff --git a/docs/pilots-corner/beginner-guide/overview.md b/docs/pilots-corner/beginner-guide/overview.md deleted file mode 100644 index b302cf0..0000000 --- a/docs/pilots-corner/beginner-guide/overview.md +++ /dev/null @@ -1,39 +0,0 @@ -Overview - -Welcome to the B78XH Beginner's Guide. Although this guide is tailored towards beginners, each topic below may even serve as reminders of proper procedure at different stages of flight for veteran sim pilots. - - - -{-- - -The Preflight page contains guides on how to set up relevant data and configurations before starting your flight. We recommend starting there. - ---} - -!!! info "Airline SOP" Please be aware that different airlines may have slightly different procedures at different stages of flight. - -!!! danger For Simulation Use Only - -- Topics - - Preflight - - Starting the Aircraft - - Preparing the CDU - - Engine Start and Taxi - - Takeoff, Climb and Cruise - - Descent Planning and Descent - - Approach and ILS Landing - - After Landing and Taxi to Gate - - Powering Down - - Abbreviations - -If you have any issues or feedback with this guide, please file an issue here: - -:fontawesome-brands-github:{: .github } - FBW Docs Issues{target=new} - -For general questions please visit our Discord: - -:fontawesome-brands-discord:{: .discord } - Discord Link{target=new} - -Authors: HowNowBrownCrow#2591 - -Guide reviewed by 787 Pilots \ No newline at end of file diff --git a/docs/pilots-corner/abbreviations.md b/docs/pilots-guide/abbreviations.mdx similarity index 99% rename from docs/pilots-corner/abbreviations.md rename to docs/pilots-guide/abbreviations.mdx index b4e68d7..19cbc30 100644 --- a/docs/pilots-corner/abbreviations.md +++ b/docs/pilots-guide/abbreviations.mdx @@ -1,7 +1,5 @@ # Boeing Standard Abbreviations -## [A](#A) [B](#B) [C](#C) [D](#D) [E](#E) [F](#F) [G](#G) [H](#H) [I](#I) [K](#K) [L](#L) [M](#M) [N](#N) [O](#O) [P](#P) [Q](#Q) [R](#R) [S](#S) [T](#T) [U](#U) [V](#V) [W](#w) [X](#X) [Z](#Z) - # A | Symbol | Meaning | @@ -75,7 +73,7 @@ # C -| Symbol | Meaning | +| Symbol | Meaning | |----------------|---------------------------------------------------------| | C | Captain
Celsius
Center | | CAB | Cabin | diff --git a/docs/pilots-guide/beginner-guide/overview.mdx b/docs/pilots-guide/beginner-guide/overview.mdx new file mode 100644 index 0000000..2418ac7 --- /dev/null +++ b/docs/pilots-guide/beginner-guide/overview.mdx @@ -0,0 +1,54 @@ +--- +title: B78XH Beginner Guide - Overview +description: The B78XH Beginner Guide teaches users how to operate and fly the Heavy Division B78XH aircraft. +--- + + + +# Overview + +Welcome to the B78XH Beginner's Guide. Although this guide is tailored towards beginners, each this guide may serve as a useful refresher for veteran sim pilots. + +Each page was reviewed by a 787 type rated pilot and provides accurate information to aircraft operation. + +{-- + +The [Preflight](preflight.md) page contains guides on how to set up relevant data and configurations before starting your flight. We recommend starting there. + +--} + +!!! info "Airline SOP" +Please be aware that different airlines may have slightly different procedures at different stages of flight. + +**For Simulation Use Only** + +--- + +| Topics | +|:-----------------------------------------------------| +| [Preflight](preflight.mdx) | +| [Starting the Aircraft](powering-the-aircraft.mdx) | +| [Preparing the FMC](preparing-fmc.mdx) | +| [Engine Start and Taxi](engine-start-taxi.mdx) | +| [Takeoff, Climb and Cruise](takeoff-climb-cruise.mdx) | +| [Descent Planning and Descent](descent.mdx) | +| [Approach and ILS Landing](landing.mdx) | +| [After Landing and Taxi to Gate](after-landing.mdx) | +| [Powering Down](powering-down.mdx) | +| [Abbreviations](../abbreviations.mdx) | + +--- + +If you have any issues or feedback with this guide, please file an issue here: + +[:fontawesome-brands-github:{: .github } - **Heavy Division Docs Issues**](https://github.com/Heavy-Division/docs/issues){target=new} + +For general questions please visit our Discord: + +[:fontawesome-brands-discord:{: .discord } - **Discord Link**](https://discord.gg/ZtbHT7jkMW){target=new} + +--- + +Authors: HowNowBrownCrow#2591 + +Guide reviewed by 787 Pilots. \ No newline at end of file diff --git a/docs/pilots-guide/beginner-guide/powering-the-aircraft.mdx b/docs/pilots-guide/beginner-guide/powering-the-aircraft.mdx new file mode 100644 index 0000000..b5cc692 --- /dev/null +++ b/docs/pilots-guide/beginner-guide/powering-the-aircraft.mdx @@ -0,0 +1,68 @@ +# Starting the Aircraft + +> Several acronyms are used in this guide to refer to specific components of the aircraft. Check the [Boeing abbreviations dictionary](docs_hd/docs/pilots-guide/abbreviations.md) for terms that seem unfamiliar. + +> Some flight deck model behaviors have not been implemented yet. We will update this guide as more functionality is added, but for now the scope of this guide is to cover the capabilities of our aircraft. + +## Cockpit Preparation +Begin by scanning the [bottom pedestal]() +* Check that the [parking brake]() is engaged (UP position) +* Ensure the [Speed Brakes]() are disarmed and retracted +* [Flaps]() are retracted +* [Engine Master Switches 1 and 2]() are both off +* [Engine Ignition]() knobs are in the `OFF` position +* [Thrust Levers]() are set to idle + +Next, move to the **center panel** and ensure the [gear lever]() is set to `DOWN`. + +Finally, move to the overhead panel and check that both the Captain's and First Officer's wipers are in the `OFF` position. + +## Overhead Panel + +## Electrical +It's necessary to supply electrical power to the aircraft in order to use any of the flight systems. +First, open the battery switch to supply power from the aircraft's main battery. Then turn on any one of the three external power switches. +If flying at night, this is a good time to familiarize yourself with the [flight deck and panel brightness lights]() and adjust as needed for visibility. + +> Some gates or stands are not equipped with ground power. This is regular at smaller airports in Microsoft Flight Simulator. You can either call a Ground Power Unit (GPU) if available or +use the APU described in the upcoming steps. + +## IRS +Prior to aligning the [IRS](), your PFD and MFD will look like ![this](). **This is normal behavior**, and indicates you have not aligned +the IRS, a system used to geolocate the aircraft's position. Align the IRS by rotating the RIGHT and LEFT knobs to `ON` position. It takes several minutes to +align [depending on your latitude](). + +> To align the IRS instantly (not realistic) open the HEAVY menu in the FMC, select the IRS configuration option, and select the `FORCE ALIGN` option. + + +![]() +## APU +To supply enough power for engine start we need to start the APU. Turn the APU knob to the "START" position. + +On the glareshield panel, ensure the APU is supplying power to the aircraft by selecting SYS on the EFIS panel, then on the MFD select the `STAT` tab. +If the EGT and voltage are rising, the APU is powering on and beginning to supply additional power to the aircraft. If the APU is not turning on, please refer to our [support guide]() for troubleshooting. +Once the RPM has reached 100% and the EGT rises to about 305 degrees Celsius, turn on `APU GEN` left and right. +> Note that the 787 Dreamliner features a 'no bleed' architecture. There is no need to supply the engines with bleed air from the APU or any external air power units, as the start sequence is handled entirely by electricity. + +## Exterior Lighting +Set NAV and LOGO light switches to the `ON` position. + +## Passenger Signs +Set the passenger seatbelt signs knob to the `ON` position. + +> In the experimental version, `AUTO` is also supported. + +> In real life, the seatbelt sign is not turned on until fueling is complete. + +## Hydraulics +Ensure the C1, C2, L and R ELEC Hydraulic knobs are set to the `AUTO` position. + +## Fuel +Ensure only the L PUMPS FWD switch is set to `ON`. + +>The default 787 by Asobo includes a bug where engaging the left center fuel pump disables the APU. This is behavior is corrected in the experimental version only. + +## Pedestal + +## Radio Panel +Select the VHF menu and on the `L` row set the active frequency to **ATIS**, and the standby frequency to the **Ground** frequency. diff --git a/docs/pilots-guide/beginner-guide/preflight.mdx b/docs/pilots-guide/beginner-guide/preflight.mdx new file mode 100644 index 0000000..ea2172b --- /dev/null +++ b/docs/pilots-guide/beginner-guide/preflight.mdx @@ -0,0 +1,50 @@ +# Preflight + +We've added features you can access once the plane is turned on. It's recommended to configure these prior to beginning your flight. + +## Navdata + +The AIRAC cycle refers to the version of navigation data currently used by the aircraft. +MSFS updates the cycle every Sim Update, and owners of a Navigraph subscription will have access to up-to-date nav data. +You may see a warning message on the Flight Management and Guidance Computer (FMGC) + +`end date of database has passed select new cycle on ident page.` + +This is warning exists to notify flight crew of outdated navdata, but can be safely ignored if you do not own a navigraph subscription. +If you do own a subscription and are seeing this message, continue reading below. + +## Flight Planning + +We recommend you do **not** use the MSFS Flight Planner (World Map) when planning routes. +The Heavy Division B78XH adds [SimBrief](https://www.simbrief.com/home/){target=new} flight planning to the 787-10. +If using flight planning tools like simBrief, you `NOT IN DATABASE`, `AWY/WPT Mismatch` OR the flight plan import may fail due to outdated/incorrect AIRAC cycle. +As we don't support outdated versions of the mod, check that you are using the most up-to-date version, as older versions have been known to lose simBrief compatibility. + +In addition to SimBrief we've added [Professional Flight Planner X](http://www.flightsimsoft.com/pfpx/) (PFPX) support as an option for flight planning. + +!!! tip "Important Links for Flight Planning" +- [SimBrief Website](https://www.simbrief.com/){target=new} (Flight Planning) +- [Little Nav Map](https://albar965.github.io/littlenavmap.html){target=new} (Flight Planning and Charts) +- [ChartFox](https://chartfox.org/){target=new} (Charts) +- [Navigraph](https://navigraph.com/){target=new} (Flight Planning and Charts) + +## Flight Plan Import + +To save time inputting your flight plan, we've incorporated a way to retrieve your simBrief flight plan and automatically enter it into the FMGC. + +![PUT GIF HERE]() + +## Manual Flight Planning + +See the Route section [guide]() on manually inputting waypoints, departures, and SID/STAR procedures. + +## Flight Plan Discontinuities + +Discontinuities such as (VECT) are normal and expected behaviors when importing flight plans. Read our page on [discontinuities]() to +better understand how to manage them. + +## Payload management + +The aircraft supports manual cargo and fuel weight, but no native tools for passenger boarding/deboarding at this time. +You may also change between metric and imperial units in the configuration settings menu. + diff --git a/docs/pilots-guide/beginner-guide/preparing-fmc.mdx b/docs/pilots-guide/beginner-guide/preparing-fmc.mdx new file mode 100644 index 0000000..a51b3ba --- /dev/null +++ b/docs/pilots-guide/beginner-guide/preparing-fmc.mdx @@ -0,0 +1,50 @@ +# Preparing the FMC + +### Disclaimer +> Various airlines have different flows and orders for setting up the FMC. +> This guide is not meant to cover all Airline SOPs, but to provide a generalized method +> of setup applicable to the simulator. + +> Some features may be missing. As we add more features we will update this guide. + +## Settings +Now that the aircraft has power, open the configuration menu by +selecting `HEAVY` on the FMC main page, `CONFIGURATION` and open the `SIMBRIEF` menu. + +From this menu you will need to input: +* Simbrief User ID +* Simbrief Username + +in order to use the integrated flight plan request tool. +Ensure that both are entered correctly. + +You can change your route import settings to import only the SID, STAR, neither, or both in the +same menu. + +The `IMPORT STRATEGY` should be set to `SB` if you are not using the native MSFS flight planner from the world menu. + +## IRS +Select the `INIT REF` then `INDEX`, and head to the `POS` page. Copy the IRS GPS Position by selecting the `GPS POS` field, and pasting by selecting the `SET IRS POST` field. + +Alternatively, you can look up the charts for your current airport and parking gate, and enter the relevent info in the `REF AUROIRT`, `GATE`, and `SET HDG` fields. +## Route +Setting up the route is fairly easy thanks to integrated simBrief flight planning. +On the FMC main page select `RTE` then `ROUTE REQUEST` on the left. Select the `LOAD FROM SB` option +if planning route from simBrief, otherwise select `LOAD FROM PFPX`. + +If you have trouble importing the route, please read our [support guide]() for troubleshooting route planning. + +**You must activate the route before using LNAV**. To do this, head back to the `RTE` page, +select the `ACTIVATE` key on the bottom right, and confirm using the `EXEC` button once the green indicator lights up. + +## Performance +In the `INIT REF` menu then `INDEX`, then select the `PERF` option. Ensure that the ZFW and other fields match your flight plan. + +> Thrust LIM is optional. For more in depth info visit our [advanced]() guide on selecting thrust limitations. We will skip this page for the purposes of this guide. + +## Takeoff configuration +Move onto the `TAKEOFF` page after `THRUST LIM`. Fill out the `FLAPS` field with a value of one of the following up to 20 degrees. + +![flaps](docs\assets\flaps.PNG) + +Then select each of the `V1`, `VR`, and `V2` speeds to automatically calculate. You will see a `FMC PREFLIGHT COMPLETE` message once you are finished. \ No newline at end of file diff --git a/feed.xml b/feed.xml deleted file mode 100644 index db981fd..0000000 --- a/feed.xml +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: null ---- - - - - {{ site.title | xml_escape }} - {{ site.description | xml_escape }} - {{ site.url }}{{ site.baseurl }}/ - - {{ site.time | date_to_rfc822 }} - {{ site.time | date_to_rfc822 }} - Jekyll v{{ jekyll.version }} - {% for post in site.posts limit:10 %} - - {{ post.title | xml_escape }} - {{ post.content | xml_escape }} - {{ post.date | date_to_rfc822 }} - {{ post.url | prepend: site.baseurl | prepend: site.url }} - {{ post.url | prepend: site.baseurl | prepend: site.url }} - {% for tag in post.tags %} - {{ tag | xml_escape }} - {% endfor %} - {% for cat in post.categories %} - {{ cat | xml_escape }} - {% endfor %} - - {% endfor %} - - \ No newline at end of file diff --git a/index.html b/index.html deleted file mode 100644 index 04319ba..0000000 Binary files a/index.html and /dev/null differ diff --git a/overrides/home.html b/overrides/home.html deleted file mode 100644 index 7149a91..0000000 --- a/overrides/home.html +++ /dev/null @@ -1 +0,0 @@ -Test \ No newline at end of file