DEP_Deprecation - Kajabi/sage-lib GitHub Wiki

Deprecation of code can be handled through two approaches:

1. Transitional deprecation

Components that are in process of being deprecated may simply be marked using the stop keyword for the corresponding entries in sage_elements within elements_helper.rb and sage_objects within objects_helper.rb. The result is that the elements will remain in the code system and documentation site but receive deprecation indicators on the Status page.

2. Full deprecation

Fully deprecated components are those that are no longer used and are no longer needed in the documentation system. Follow this process:

1. Move the deprecated entries in sage_elements within elements_helper.rb and sage_objects within objects_helper.rb to the sage_deprecated_... lists therein. Be sure to mark each component's implementation context as stop if it is not already marked accordingly.
2. Remove the .erb files from the within the app/views/examples.
3. Remove the .scss files and their imports from within lib/sage-frontend/stylesheets/system.

The result is that these components will be archived in the Status page with the deprecated markers, but no longer be contained in the system source files.