feat(failures): update with generator + images + inline bootstrap icon config

[Valastiri]

closes: #860

Summary

In support of A32NX PR:

• feat: Random Failures aircraft#7821

Please reference issue above for more information.

• Added photoshop PSD into /src that has a basic template for cropping and sizing EFB images to match our style divs if required. (Just a handy inclusion)
• feat: added config for inline bootstrap icons
• feat: added to /src for original TAKEOFF icon combined in html

Also scrubbed the idea for a new page as everything was able to live on a single page and prevents a further nested directory.

Current Active List TODO

• Update + refactor failures page with new title for cleaner slug

Location

Discord username (if different from GitHub): valastiri

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 20, 2023 8:35am

[Maverickwoe]

Apologies. Due to a request from donstim, I moved the max simultaneous failures setting in all the generators to avoid ambiguity.
Pages now look like this
Altitude

[Maverickwoe]

Speed

[Maverickwoe]

Probability over time

[Maverickwoe]

Timed failure

[Maverickwoe]

Take Off

Bottom part

[Maverickwoe]

Main page does not display anymore the maximum number of simultaneous failures.

[Maverickwoe]

Thanks a lot for the page @Valastiri
Can I suggest to

• update the old images too ? they lack the new tab.
• mention "corresponding tabs" in the second paragraph ? It would be nice to make the user understand to which "buttons" this relates on the page. Or maybe mention these tabs at the beginning of each chapters "On Demand Failures" and "Failure Generators"
• "Note: In aviation, rates of failure" : missing the coma
• Can you add "ground speed" every time speed is mentioned ? all generators are based on ground speed so that gusts do not impact the result.
• Max Failures and Number of Failures: Can you replace with this text that covers better the recent changes ?
  "Each generator defines a specific number of failures to be triggered at the same time and a maximum number of failure. The number of failures will activate up to the total number of failures on the plane."
• Could you kindly also add the takeoff diagram in the take off generator ?
  Thanks

here are screenshots for the old pages:

[Valastiri]

Thanks a lot for the page @Valastiri

Can I suggest to

• update the old images too ? they lack the new tab.

• mention "corresponding tabs" in the second paragraph ? It would be nice to make the user understand to which "buttons" this relates on the page. Or maybe mention these tabs at the beginning of each chapters "On Demand Failures" and "Failure Generators"

• "Note: In aviation, rates of failure" : missing the coma

• Can you add "ground speed" every time speed is mentioned ? all generators are based on ground speed so that gusts do not impact the result.

• Max Failures and Number of Failures: Can you replace with this text that covers better the recent changes ?

"Each generator defines a specific number of failures to be triggered at the same time and a maximum number of failure. The number of failures will activate up to the total number of failures on the plane."

• Could you kindly also add the takeoff diagram in the take off generator ?

Thanks

here are screenshots for the old pages:

I'll look into this by tomorrow hopefully. For images I just don't have time to run the sim but I'll try and get the artifact to take some screenies.

[Maverickwoe]

Thanks for the updates. Looking good so far !
Just noticed maybe an improvement on the text I gave you:
"TAKE OFF : The generator will wait until FL or TOGA thrust is set to arm itself. It will trigger a set of failures only once until another take off event occurs."
Could be improved by
"TAKE OFF : The generator will wait until FL or TOGA thrust is set while on the ground to arm itself. It will trigger a set of failures only once until another take off event occurs."

Up to you.

[Valastiri]

Thanks for the updates. Looking good so far ! Just noticed maybe an improvement on the text I gave you: "TAKE OFF : The generator will wait until FL or TOGA thrust is set to arm itself. It will trigger a set of failures only once until another take off event occurs." Could be improved by "TAKE OFF : The generator will wait until FL or TOGA thrust is set while on the ground to arm itself. It will trigger a set of failures only once until another take off event occurs."

Up to you.

This does sound better I'll make that change in a bit.

I'll batch the images and optimize them for each failure provided the ones you've sent are still valid / current. I haven't had a chance to update my sim or download the artifact so I'm counting on that heh.

As soon as I've gotten the images this should be RTR

[Maverickwoe]

Here's a photoshopped combined version of the two pages of settings from take off generator. You will obviously need to scroll to see all of them but might be better for the documentation

[Valastiri]

Takeoff diagram will be WIP and may come at a later date. Hopefully can get it branded before a32nx PR is merged

[github-actions]

This PR is being prevented from merging because Review Required. Use the Approved label to run build validation and auto merge the PR.

[Maverickwoe]

Hey @Valastiri
Following the latest updates, could you kindly modify the doc with these elements:
1/ Below the "configuration options".
Could you put something that refers to the two colors of the icon
white:

The generator is not armed
blue:

The generator is armed
2/ Could you put the corresponding icons next to each options of the "configuration options"
take off

off

once

repeat

[Maverickwoe]

bigger icons




Direct access to the bootstrap icons. You might use them directly in your html
https://icons.getbootstrap.com/icons/airplane/
https://icons.getbootstrap.com/icons/arrow-bar-up/
https://icons.getbootstrap.com/icons/toggle-off/
https://icons.getbootstrap.com/icons/repeat/
https://icons.getbootstrap.com/icons/repeat-1/

[Maverickwoe]

can you add the button icon in a new section "Failure generator settings" below the section "Failure Pool Selection"
Text would be.
You can access the settings of each failure generator by pressing the icon
https://icons.getbootstrap.com/icons/sliders2-vertical/

[Maverickwoe]

bigger blue icon

[Maverickwoe]

Can you add in the section "Timed Failure Generator"
Note : The timer is running when the generator mode icon is blue

[Maverickwoe]

Can you add at the end of the section "Altitude Failure Generator"
The failure generator can only arm itself when the plane is outside of the altitude activation range with an extra margin of 100 feet.
The generator mode icon will therefore stay white if the plane is within the altitude activation range

Can you add at the end of the section "Speed Failure Generator"
The failure generator can only arm itself when the plane is outside of the speed activation range with an extra margin of 5 knots.
The generator mode icon will therefore stay white if the plane is within the speed activation range

[Maverickwoe]

Can you modify this with the additional text (in bold)
"When configured in the "Take Off" arming, the timer will start once FLEX or TOGA thrust is set for the first time and the plane moves."

[Maverickwoe]

Can you modify this with the additional text (in bold)
"TAKE OFF: The generator will wait until FLEX or TOGA thrust is set while speed is low on the ground to arm itself. It will trigger a set of failures only once until the plane entirely stops and another take off event occurs.

[Valastiri]

@Maverickwoe Hallo there!

Icons + descriptions to follow later as I only had time to put in the text-based changes for now.

---

Can you add in the section "Timed Failure Generator" Note : The timer is running when the generator mode icon is blue

Done - within "info" admonition

---

Can you add at the end of the section "Altitude Failure Generator" The failure generator can only arm itself when the plane is outside of the altitude activation range with an extra margin of 100 feet. The generator mode icon will therefore stay white if the plane is within the altitude activation range

Can you add at the end of the section "Speed Failure Generator" The failure generator can only arm itself when the plane is outside of the speed activation range with an extra margin of 5 knots. The generator mode icon will therefore stay white if the plane is within the speed activation range

Done - within "info" admonition

---

Can you modify this with the additional text (in bold) "When configured in the "Take Off" arming, the timer will start once FLEX or TOGA thrust is set for the first time and the plane moves."

Where exactly am I adding this information?

---

Can you modify this with the additional text (in bold) "TAKE OFF: The generator will wait until FLEX or TOGA thrust is set while speed is low on the ground to arm itself. It will trigger a set of failures only once until the plane entirely stops and another take off event occurs.

Done

[Maverickwoe]

Can you modify this with the additional text (in bold) "When configured in the "Take Off" arming, the timer will start once FLEX or TOGA thrust is set for the first time and the plane moves."

Where exactly am I adding this information?

this is a change in the TAKE OFF mode description in the section "Configuration Options"