-
Notifications
You must be signed in to change notification settings - Fork 2
Deprecation
Deprecation of code can be handled through two approaches:
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.
Fully deprecated components are those that are no longer used and are no longer needed in the documentation system. Follow this process:
- Move the deprecated entries in
sage_elements
withinelements_helper.rb
andsage_objects
withinobjects_helper.rb
to thesage_deprecated_...
lists therein. Be sure to mark each component's implementation context asstop
if it is not already marked accordingly. - Remove the
.erb
files from the within theapp/views/examples
. - Remove the
.scss
files and their imports from withinlib/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.
Thanks for using Sage!
Welcome
Conventions
Processes and Reference