Skip to content

Starting NORTH docs#197

Merged
lukaspie merged 12 commits intodevelopfrom
64-missing-how-to-use-north
Jan 29, 2026
Merged

Starting NORTH docs#197
lukaspie merged 12 commits intodevelopfrom
64-missing-how-to-use-north

Conversation

@lukaspie
Copy link
Contributor

@lukaspie lukaspie commented Jan 14, 2026

  • Adds a how-to guide for using the NorthToolEntryPoint and how to create the Docker images
  • Adds the automated reference for NorthToolEntryPoint
  • Fills the existing, empty docs/howto/manage/gui/north.md with a how-to example we'll do this in a separate PR, see Fill out "How to analyze data in NORTH" #205
  • Adds an explanation page for north (in docs/explanation/north.md)

@lukaspie lukaspie linked an issue Jan 14, 2026 that may be closed by this pull request
@github-actions
Copy link
Contributor

🤖 Hi @lukaspie, I've received your request, and I'm working on it now! You can track my progress in the logs for more details.

@github-actions
Copy link
Contributor

🤖 I'm sorry @lukaspie, but I was unable to process your request. Please see the logs for more details.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 14, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://FAIRmat-NFDI.github.io/nomad-docs/pr-preview/pr-197/

Built to branch gh-pages at 2026-01-29 11:32 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@lukaspie lukaspie force-pushed the 64-missing-how-to-use-north branch from 1643108 to 0f4e7d3 Compare January 14, 2026 15:41
@mkuehbach mkuehbach self-requested a review January 27, 2026 12:27
Copy link
Contributor

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good overall, some cross-refs and wip marking eventually

lukaspie and others added 8 commits January 27, 2026 17:00
* collecting material first

* working on the description of the tools

* updates

* add context and explanation for further tools

* done with walking through all containers, past and present ones

* initial proof-reading, needs feedback now

* work in feedback from the last tf meeting, work on previously untouched footer and header sections, reduce reporting of the history behind the tools, mark for each tool what should happen to these and where that tool-specific part of the documentation should go

* typos, a proof-reading round, ready for review

* add connection to #186 plugin registry page

* worked in comments from lukaspie

* remaining reviewer comment

---------

Co-authored-by: mkuehbach <markus.kuehbach@physik.hu-berlin.de>
@lukaspie lukaspie force-pushed the 64-missing-how-to-use-north branch from 6345263 to 7560d96 Compare January 27, 2026 16:00
RubelMozumder and others added 4 commits January 29, 2026 10:59
* First structure.

* Update north docs.

* Minor fix.

* Fix file structure.

* Resolving PR comments.


** Docs include: 

- Explanation for Docker image: writting docker file, build docker file, testing, and tagging the Docker image.
- Use of NORTHTool and NorthToolEntryPoint demo,
@lukaspie lukaspie marked this pull request as ready for review January 29, 2026 12:21
@mkuehbach mkuehbach self-requested a review January 29, 2026 12:22
Copy link
Contributor

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A good composite

@lukaspie lukaspie merged commit 0259481 into develop Jan 29, 2026
13 checks passed
@lukaspie lukaspie deleted the 64-missing-how-to-use-north branch January 29, 2026 12:26
lauri-codes pushed a commit that referenced this pull request Feb 6, 2026
Co-authored-by: mkuehbach <markus.kuehbach@physik.hu-berlin.de>
Co-authored-by: lukaspie <lukaspie@github.com>
Co-authored-by: Markus Kühbach <mkuehbach@users.noreply.github.com>
Co-authored-by: RubelMozumder <32923026+RubelMozumder@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants