menu
Logo
  • Warum azing?
  • Blog
  • Hilfe
DEarrow_drop_down
  • DE
  • EN
Suche in Checklisten
search
azing Logo DEarrow_drop_down
  • DE
  • EN
  • Warum azing?
  • Hilfe
2sxc
drive_folder_upload
  • homeChecklisten-Vorlagen
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedDocumentation

  • info Typ ändern: Information
  • insert_drive_file Typ ändern: Textbaustein
  • homeChecklisten-Vorlagen
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedDocumentation

Ordner und Checklisten

  • check_circleCreate a long term archived version for vXX

Teile dieser Checkliste (0) expand_more

Teil-Dokumente werden als von anderen Checklisten wiederverwendet, sind aber nicht geeignet als Einstieg in eine Tätigkeit. Deshalb erscheinen sie weiter unten. Die Suche wird diese auch nicht anzeigen, ausser man sucht explizit nach Teilen. 

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

Add the Archive - Option 1 (recommended)

Important: This assumes you already have a c:\projects\2sxc\v##\ folder containing the stable, LTS or similar code.

  1. Copy the entire docs folder in your c:\projects\2sxc-docs\ to c:\projects\2sxc\v##\2sxc-docs-v##
  2. Correct git target using git remote remove origin and git remote add origin https://github.com/2sxc-dev/2sxc-docs-v##.git
  3. Make sure you change primary git branch to main git branch -M main
  4. Rename the workspace to something like 2sxc Docs v## Archive.code-workspace
  5. Build / Push

Add the Archive - Option 2 (older, should work too)

  1. 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. 
  2. 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.
  3. 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.

Home changes

  1. Lock beside title
  2. Info "ARCHIVE 🔒 Documentation" and info under it
    1. copy from previous archive
    2. update the text / version numbers in that section

Changes in _master.tmpl

  1. Before you change _master.tmpl, create archive.md in the pages like in the v19 (for linking in the menu later - note that the v21 archive has some instructions)
  2. Version Picker: Change the label of the search, add a 🔒 similar to the v19 master
  3. 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 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>
  1. Add a 🔒 v## ARCHIVE to the header w/Link similar to v19 and link to the /archive.html
    1. make sure you adjust the version number in the copied code

Changes to the Build / Template

Change DocFx Build to Disable Edit

  1. Change the docfx.json to set disableGitFeatures to true 
  2. also set _disableContribution to true
  3. Verify that the build now doesn't have "edit this page" in the footer
  4. Change the _appTitle to something like 2sxc Docs v21 🔒

Add a robots.txt to avoid Indexing

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

Deploy to Pages

  1. go to the pages configuration like https://github.com/2sxc-dev/2sxc-docs-v21/settings/pages and configure everything
  2. Save and wait for it to build, this can take a few minutes - you should then see this
  3. Then configure the domain vXX.docs.2sxc.org
    1. setup DNS in cloudflare, CNAME to 2sxc-dev.github.io
    2. add the domain to the pages settings
    3. await till it works - can take a while - then set enforce https
    4. verify that it works
  4. Set repository to archive, as it should not change and not trigger git-alerts on old npms

Change the main Redirector to also list the old pages

  1. In the docs-versions.md, copy the section from the previously archived version and update the version number in
    1. title
    2. logo
    3. link
  2. Build / test
Logo
Rechtliches | Inhalts-Copyright CC-BY 4.0
bug_reportFehler melden
  • info
  • Links
  • Rechte
code Teilen
code
URL in Zwischenablage kopiert.
Checkliste einbetten close
Kopieren Kopieren
Inhalts-Copyright

CC-BY 4.0

Übersetzungen

Keine

2sxc - Content Management for DNN & Oqtane Logo

2sxc - Content Management for DNN & Oqtane

QR-Code
azing.org/2sxc/r/u0zKWF-I
Anschauen & Verwenden

Öffentlich (nutzbar für jeden)

Bearbeiten & Verwalten

Standard (alle Mitglieder können bearbeiten)

Dieser Katalog verwendet ein einfaches Berechtigungsmodell, bei dem alle Mitglieder die selben Rechte haben. Für weitere Optionen, bitte Upgraden.

Hier siehst du die Beziehungen zwischen diesem Dokument und anderen.

Used (0)

Andere, die hierhin verweisen

Verwendet diese (0)

Andere, die in diesem Dokument verwendet werden

Wie es verwendet wird

Die Kategoriesierung verändert das Verhalten des Dokuments.

Dies ist ein normales Dokument, es wird normal angezeigt und erscheint in der Suche.

Typ

Das ist eine Checkliste. Listen werden zu Checkboxen umgewandelt.

Haben Sie etwas zu sagen?

Kommentieren Sie, um eine Diskussion zu beginnen oder eine Notiz zu machen
send

Bitte einloggen um zu chatten.

close

Durchsuche ganz Azing