Skip to content

Commit

Permalink
Migration docs formatting fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
Sudershan29 committed Jun 11, 2024
1 parent 951dac0 commit 72c4473
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/source/reference/migration.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
.. _migration_reference:

Migration
========
=========

Migrating to v0.3.0
-------------------

v0.3.0 introduces a fresh styling for the DGPF portal. You can migrate to the
new design by changing the following in your own `settings.py`.

.. code-block::
.. code-block:: python
# Changing base_template from v2 to v3
BASE_TEMPLATES = 'globus-portal-framework/v3/'
You can overwrite the existing templates for v3 version by replacing the template
You can overwrite the existing templates for the v3 version by replacing the template
files (.html) and styling (.css) in `templates/globus-portal-framework/v3/` and
`static/globus-portal-framework/v3/` respectively.

.. note::

* NOTE: In case you want to revert back to the `v2` styling, simply undo the
`BASE_TEMPLATES` value in your `settings.py`.
In case you want to revert back to the `v2` styling, simply undo the
`BASE_TEMPLATES` value in your `settings.py`.

.. warning::

* WARNING: Breadcrumbs have been removed as part of the default `v3` styling, but users
are encouraged to add their own styling (if their usecases require the breadcrumb) and
uncomment breadcrumb codesegment in `templates/globus-portal-framework/v3/base.html`.
Breadcrumbs have been removed as part of the default `v3` styling, but users
are encouraged to add their own styling (if their use cases require the breadcrumb) and
uncomment the breadcrumb code segment in `templates/globus-portal-framework/v3/base.html`.

0 comments on commit 72c4473

Please sign in to comment.