Giter VIP home page Giter VIP logo

docs's Introduction

docs's People

Contributors

surfnet-niels avatar thijskh avatar tvdijen avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Documentation missing file on https://simplesamlphp.org/docs/latest/index.html

on https://simplesamlphp.org/docs/latest/index.html
there is a link to "Automated Metadata Management" that points to https://simplesamlphp.org/docs/latest/metarefresh/simplesamlphp-automated_metadata.html.
That link is dead, the url is points to a 404 document not found in the latest documentation.

It works in https://simplesamlphp.org/docs/1.19/index.html however and there it points to
https://github.com/simplesamlphp/simplesamlphp-module-metarefresh/blob/master/docs/simplesamlphp-automated_metadata.md

Missing documentation (dead links)

Describe the bug
The simpleSAMLphp documentation contains a lot of dead links.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://simplesamlphp.org/docs/latest/simplesamlphp-idp.html
  2. Click on "authcrypt:Hash" or "ldap:LDAP" or "sqlauth:SQL" or ...
  3. See error 404 File not found

Expected behavior
Existing documentation, links not dead.

Screenshots or logs
screenshot_2022-06-10_115411

Additional context
Also checked docs/ directory in Github, but the files are not present there either.

Broken/dead documentation links:

Add anchor to all H2 elements

For backwards compatibility and easy pointing to the documentation from external resources we should support having an anchor for all H2 elements in the documentation

Trigger docs rebuild on main repo change

Currently the docs website is only rebuilt when something changes in this repo.

However, it should be rebuilt if the source files change. Those live primarily in the simplesamlphp/simplesamlphp repo (but, to make things complicated, also sometimes in module repos).

Some possible solutions:

  • Trigger this repo's workflow when a commit (including docs changes?) is done in the ssp main repo. And/or do the same from the module repos.
  • Just rebuild this repo periodically (daily/weekly).

Version links

On the old site, it was possible to go to a specific piece of documentation and then switch to the same doc for another version using the version-links.
On the new site the version-links just redirect you to the index-page for a specific version rather than the specific doc

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.