menu
Logo
  • Why azing?
  • Blog
  • Help
ENarrow_drop_down
  • DE
  • EN
Suche in Checklisten
search
azing Logo ENarrow_drop_down
  • DE
  • EN
  • Why azing?
  • Help
2sxc
drive_folder_upload
  • homeChecklist Templates
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedDocumentation

  • homeChecklist Templates
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedDocumentation

Folders and checklists

  • check_circleCreate a long term archived version for vXX

Parts (0) expand_more

These are small document-parts which are used in other documents. They are not a starting point for any real activity. Because of this, they will be listed further down and the search will not list them unless requested. 

Whenever we make bigger changes to the code base or clean up old docs, it's important to preserve the old docs for reference. Here's an example: https://v16.docs.2sxc.org/ 

Note that for this process, the old docs will need to be rebuilt a few times, so that the layout etc. will be modified to show it's an archive. 

Build the Archive

  1. Create a new repo in https://github.com/2sxc-dev/ using a name like 2sxc-docs-v19
  2. Git clone to local - at the same level as the old docs
    1. probably c:\projects\2sxc-docs-v19
    2. ...but if the original code has already changed too much, place it in the correct place with older 2sxc/eav code, so that rebuilds will still take that. 
  3. In the original docs, take the latest (or a previous commit) to get the copy which will be archived; copy all of it into that folder.
  4. Rebuild, verify it works

Mark the Archive Pages to show they are Archives

We need to make changes to the layout similar to the v16 archive.

  1. Home changes
  2. Version picker changes in _master.tmpl
    1. Change the label
    2. Change the link to go to the latest version
  3. Create archive.md in the pages like in the v19 (for linking in the menu later)
  4. Add this note to each page in the _master.tmpl - (between the <article...> tags)
<article data-uid="{{uid}}">
  <!-- Special archive note header -->
  <div class="alert alert-danger d-print-none">           
    These v19 docs are <a href="/archive.html">archived 🔒</a>.
    Go to the
    <a href="https://docs.2sxc.org" target="_blank">latest docs home</a>
    or try if
    <a href="https://docs.2sxc.org/{{_path}}" target="_blank">this exact page is available</a>
    in the latest docs.
  </div>
  {{!body}}
</article>

Changes to the Build / Template

  1. Change DocFx Build to Disable Edit
    1. Change the docfx.json to set disableGitFeatures to false 
    2. Verify that the build now doesn't have "edit this page" in the footer
  2. Change the current Version Switcher
    1. Modify the _master.tmpl in a way similar to the v19 archive
  3. Add a 🔒 v## ARCHIVE to the header w/Link similar to v19 and link to the /archive.html

Add a robots.txt to avoid Indexing

  • create a /docs/robots.txt (so directly in the output folder) and add this:
User-agent: *
Disallow: /

Change the main Redirector to also list the old pages

todo

Logo
Legal | Content Copyright CC-BY 4.0
bug_reportReport Bug
  • info
  • Links
  • Permissions
code Share
code
URL copied to clipboard.
Embed Checklist close
Copy Copy
Content Copyright

CC-BY 4.0

Translations

None

2sxc - Content Management for DNN & Oqtane Logo

2sxc - Content Management for DNN & Oqtane

QR-Code
azing.org/2sxc/r/u0zKWF-I
View & Use

Public (can be used by everybody)

Edit & Admin

Default (all members can edit)

This catalog has a simple permission model, where all members have the same permissions. For advanced permissions, upgrade to Enterprise.

Here you can see how this document is used and linked by other documents

Used in (0)

Others referencing this

Uses these (0)

Documents linked from this document

How it Behaves

How this document is categorized changes how it behaves.

This is a main document, it is listed normally and appears in search result.

Type

This is a Checklist. Lists are converted into checkboxes.

Get something to say?

Comment to start a discussion or make a note
send

please log on to chat

close

Durchsuche ganz Azing