Rewrite Ferris Product Documentation (ferrislabs.net)

[fcaprez]

• [x] Develop parameter based doc structure (Ferris Labs / Gridmine)
• [x] Review, revise, complete Ferris Documentation
• [ ] Proof Read new Ferris Documentation
• [ ] Add new Graphic to Ferris Documentation
• [ ] Publish new Ferris Documentation to ferrislabs.net
• [x] Ferris FX needs a clear product category

[fcaprez]

Master content is hosted on stream-zero / shared-docs-source

All edits will be done on local DEV branch

[fcaprez]

OPEN ISSUES AND QUESTIONS

The following list of items is a collection of questions/topics from the website documentation review:

General Considerations

• [x] Adding 'copy to clipboard' function for tutorial steps and code snippets
• [x] The term DX is still not used consistently -- removed all DX references
• [x] Adding cross-reference links throughout

Ferris FX

• [x] Ferris FX needs a clear product category. We need to be able to say "Ferris FX is a [ devops platform, development platform, paas, or similar]" so that a clear definition of FX can be looked up and/or documented.
• [x] Suggest to add an overview section that highlights the purpose and audience of FX. I would also mention the explicit and direct vicinity to DevOps and GitOps -- no, will keep tech language only on Ferris Docs
• [x] Plug into anything: No-Code or Low-Code take your pick >>> removed sentence // @ragingbal to rewrite sentence
• [x] Fully Containerised and Easy to Deploy: written in italics >>> removed italics / already available
• [x] All Ops Data in 1 Secure place: written in italics >>> removed italics / already available
• [x] Structured Service Documentation: written in italics >>> removed italics / already available
• [x] Simple Easy to understand and use conventions: ... and also deploy your won (???) packages with each service

Architecture Overview

• [x] What are DAGS (need to spell it out)
• [x] Elasticsearch: references may need to be replaced with Clickhouse soon

Dev Guide: Your First FX...

• [x] Step 6: GitIgnore Link not working
• [x] 2x "Feel free..." paragraphs: Are these intended to be there, or are they internal references?

Developer Guide > Deploy a Service

• [x] All image links are broken

Developer Guide > Project and Code Structure

• [x] Where did the section or page Manifest File go?

Developer Guide > Secrets

• [x] Create a new Package: refers to where it is presented // where is that page/section
• [x] Image links are broken

Developer Guide > Form Generator

• [x] Image links are broken
• [x] Following sentence is unclear: When the form values are entered and the 'Run' Button is clicked the form parameters and values will be sent to the service on trigger and these will be available to the service just as if it were trigerred by an event with the same payload as the form values.

Developer Guide > Database Integrations

• [x] Using DX instead of FX
• [x] Link reference to Extending Executor image

Developer Guide > Event Source Adaptors

• [x] List of adaptors needs all or none descriptions for each adaptors
• [x] Jojo Mayer video // replace with video on how to generate a token?
• [x] Flow diagram svg is huge // replace with smaller URL
• [x] Image links are broken
• [x] AWS Event Bridge Video: keep or replace?

Developer Guide > Extending the Platform

• [x] Add doc links to all references in the lists
• [x] 3. At Exit Point: ... operate across the example ???

Developer Guide > Git Integration

• [x] Image links are broken

Developer Guide > Event Manipulation

• [x] ... FX events are based on CloudEvents ... // more to come..?

Developer Guide > Logging & Monitoring

• [x] Move L&M to User Guide
• [ ] Elasticsearch index is XYZ ???
• [ ] The following is a sample log entry with extended descriptions below // no example listed
• [ ] To Filter Application Logs use the following ???
• [ ] App_name: ???
• [ ] Event Name Spaces ???

Security

• [x] Complete Index page
• [x] Finish sections at the bottom of the Security main page

User Guide > Landing Page

• [x] Explain how widgets are created or edited - not for the user guide (should be explained elsewhere, for Platform Engineer)
• [x] Image links are broken

User Guide > Projects

• [x] The default owner for new projects is the Platform Admin (PA) >>> true or Platform Owner (?)
• [x] Confusing statements about PO and PA
• [x] Image links are broken

[fcaprez]

New Findings (by Felix)

Projects

• [ ] added new Details section with screenshot (add screenshot to source repo)
• [ ] added new Charts section, with a Link to Charts page (add Charts page; add link to Charts page)