search

NixOS / nix.dev

Official documentation for getting things done with Nix.
https://nix.dev
Creative Commons Attribution Share Alike 4.0 International
2.43k stars 242 forks source link

prominently show revision date and history #297

Open olafklingt opened 2 years ago

olafklingt commented 2 years ago

(the suggestion is based on my experience with the existing documentation that is spread over multiple places and not a comment on the this book project.)

To evaluate if information is valid (current best practice) it is helpful to know (while reading the documentation) when it is written. Therefore I recommend:

  1. The nixos-wiki should show the date when a page was last edited.
  2. The sections in the (nix, nixpkgs, nixos) books should show a date when the source file was last edited.
fricklerhandwerk commented 2 years ago

The nixos-wiki should show the date when a page was last edited.

@Mic92 is that something you can help arrange?

The sections in the (nix, nixpkgs, nixos) books should show a date when the source file was last edited.

As long as it's purely on GitHub, it will show the edit history. This should be incorporated in a future independent web rendering.

Mic92 commented 2 years ago

The nixos-wiki should show the date when a page was last edited.

@Mic92 is that something you can help arrange?

Arrange what? Each wiki page has a history that shows the date: https://nixos.wiki/index.php?title=NixOS&action=history

olafklingt commented 2 years ago

The proposal in this issue is to add the edit date information to the rendered (user facing) html.

fricklerhandwerk commented 2 years ago

@Mic92 Each wiki page has a history that shows the date

That is technically true, but you have to log in to even see that page, and it's hidden in the drop down of the "Edit" button. @olafklingt has a valid claim there: The last modified timestamp should be right in the header of the page to quickly assess how up-to-date a document is.

Is that something we could do with the current setup? Who would we ask?

Mic92 commented 2 years ago

You could try to ask fadenb in the matrix, who solely administrate the wiki. There is also no public configuration of the current setup. I do backups of the wiki in case fadenb disappears for some reason. I don't think I can change this unless it's some setting that one can do in some mediawiki template?

olafklingt commented 2 years ago

I don't know anything about Wikimedia but Wikipedia has the edit date at the bottom of each page. Nevertheless it will depend on the implementation of the template if this is an option.