[WAIT] Talk to PDC about Dardel documentation

[paran1]

Dardel is a PDC system not an UPPMAX one. We have have to provide some Dardel-related documentation to assist migration, but I don't think Dardel should be in the menue with our own systems. Maybe have another menu somewhere with links to other/external systems.

Also I don't think we should have dedicated pages for how to login to PDC/Dardel or create SSH keys for this.

We should instead have links to PDCs documentation. If we believe PDCs documentation is insufficient we should provide suggestions for improvements to them.

[richelbilderbeek]

I agree that Dardel is not an UPPMAX system.

but I don't think Dardel should be in the menue with our own systems. Maybe have another menu somewhere with links to other/external systems.

Great suggestion! I am unsure how this will work out, but I'll try to make Dardel appear to be less UPPMAXy

We should instead have links to PDCs documentation

We do. They do keep breaking, hence these get deleted to fix the CI scripts

If we believe PDCs documentation is insufficient we should provide suggestions for improvements to them.

I am sure we discussed providing suggestions for improvements with them. I am unsure why we decided we didn't. One hypothesis is that we want to discuss this at a meeting with them, where I was not present and it may now have been forgotten.

I'll ask around again, thanks!

[paran1]

but I'll try to make Dardel appear to be less UPPMAXy

great!

They do keep breaking, hence these get deleted to fix the CI scripts

not sure what that means, maye ask PDC if their web page is unstable?

I am sure we discussed providing suggestions for improvements with them.

I think this depends much if you/we have talked to PDC. If they don't mind/care then all is fine.

Consider for example what we would think if NAISS suddenly published their own "login to UPPMAX"-documentation?

[richelbilderbeek]

Consider for example what we would think if NAISS suddenly published their own "login to UPPMAX"-documentation?

I think that would be quite insightful!

[richelbilderbeek]

I asked @MarcusUppmax on wether to contact PDC.

[richelbilderbeek]

@MarcusUppmax thinks PDC would enjoy some concrete suggestions for improvement.

[richelbilderbeek]

Richel will bring Marcus up to speed 👍

[richelbilderbeek]

I've informed @MarcusUppmax, already a while ago. But hey, he has quite many things to do 👍

[richelbilderbeek]

I added the 'discuss at a meeting' label, as I think @MarcusUppmax may need to be reminded next week 👍

[richelbilderbeek]

Discussed at a meeting and I was encouraged to contact PDC. I sent the text below to Henric Zacci:

Hi Henric,

We've met a couple of times and I think I should get this ball rolling:

At UPPMAX, I am a staff member that enjoys writing documentation for our less technical users. When I wrote the Rackham-to-Dardel-migration guide [1] one can find a simple stepwise procedure with screenshots and a video. The PDC documentation for, for example, logging in felt too technical for our regular users and I ended up writing it down at the UPPMAX documentation too [2]. However, as a colleague also stated on GitHub [3], maybe I should contact PDC and ask if I could be allowed to improve (i.e. if PDC agrees on the word 'improve') the PDC documentation.

Would it be possible that we can agree on some rules that I am allowed to work on part of the PDC documentation that is relevant for the users that migrate from Rackham to Dardel?

A 'no' is fine, a 'yes' or meeting would be awesomer!

Cheers, Richel Bilderbeek

• [1] https://uppmax.github.io/UPPMAX-documentation/cluster_guides/dardel_migration/

• [2] https://uppmax.github.io/UPPMAX-documentation/getting_started/login_dardel/

• [3] [WAIT] Talk to PDC about Dardel documentation #23

[richelbilderbeek]

Reply by Henric:

I think your proposal sounds great.
We know our documentation is a bit technical and not layed out in the best possible manner.
At the moment all of our documentation is in sphinx/ReST within the KTH github.
At the moment we are discussing of changing that, to make it publicly available and also convert
it to MD using mkDocs and make it more graphically appealing. This is in line with how we want to transition
documentation within NAISS
as well.
So the simple answer is yes, but let me get back to you when I have discussed it internally and also within NAISS, and
make the documentation available on public github so I can give you access (In kth github you need a KTH account).

I thanked him already for this :-) . Now it's just waiting 👍

[richelbilderbeek]

Still waiting ...