search

m2ms / fragalysis-frontend

The React, Redux frontend built by webpack
Other
1 stars 2 forks source link

Tidy up fragalysis repos in githup - root repo etc. #1122

Open phraenquex opened 1 year ago

phraenquex commented 1 year ago

Intitial draft, for now.

phraenquex commented 1 year ago

Would happen after #1077

xchem-super commented 12 months ago

Getting started spinning up development of stack, specifically, how to build a container image and the architecture of Fragalysis (how it is put together?). the target audience is stack developers, this is very much related to concept/idea of dev containers (@alanbchristie and @Waztom to review)

phraenquex commented 11 months ago

Create a "fragalysis-root" repo (or similar).

Retire the https://github.com/xchem/dls-fragalysis-stack-kubernetes repo

Adopt @alanbchristie's stack repo.

And make a nice Read.me file.

phraenquex commented 10 months ago

Will happen in the new year- can wait, no functional implications.

alanbchristie commented 9 months ago

To deal with the root repo, 'fork' https://github.com/xchem/dls-fragalysis-stack-kubernetes into xchem. Once done you can then manage any documentation and Ansible playbooks.

The repo is responsible for all the Ansible playbooks that are executed by the AWX server in the developer and production clusters. Once the repo has been forked edit the AWX Project records on the two AWX servers. This will ensure that the new repository location is used when downloading the playbooks when the corresponding Job Templates run. The two servers are located at: -

When the switchover is complete we can then Archive the IM repository (make it read only).

We can fork the repository at any time, the switch over can be done gradually.

alanbchristie commented 9 months ago

The origin repo is already forked to xchem: -

Someone with authority probably needs to: -

  1. Synchronise this fork with the upstream (origin) repo (see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#) [REPLACED]
  2. Rename the fork to fragalysis-stack-kubernetes? [DONE]
  3. Update AWS server Project references [DONE]
  4. Create a new ReadTheDocs page so its content is compiled from the fork rather than the origin. [DONE]
  5. Remove the old ReadTheDocs page [TO DO]
  6. Declare a root repository and provide "welcome" documentation. Is it the fragalysis-stack-kubernetes repo? [TO DO]
phraenquex commented 9 months ago

@Waztom please act on @alanbchristie's request.

Waztom commented 9 months ago

@alanbchristie have added you with write permissions. Please let know if you need more access (admin level).

alanbchristie commented 9 months ago

I have now archived the Informatics Matters repository (https://github.com/InformaticsMatters/dls-fragalysis-stack-kubernetes). This repo has now been forked to the xchem domain as: -

alanbchristie commented 9 months ago

@Waztom As I have resorted to re-forking the original repository, the earlier fork can now be archived, and probably removed? ...

...because the above has been replaced by...

Waztom commented 9 months ago

@alanbchristie one thing, can you please confirm that we will not be loosing code/fork that was specifically applicable to deploying on Diamond's Kubernetes? Diamond/Chris has their own Kubernetes (last I heard, still only available to people accessing from within the Diamond firewall), whilst Fragalysis is deployed on STFC's Kubernetes.

alanbchristie commented 9 months ago

AFAIK (and after reviewing the commits) the fork of our (original) repository was only changed by Rachael for three purposes: -

  1. Updated the documentation configuration (probably for ReadTheDocs) [10 Jun 2020] (Now out of date)
  2. Fixed Travis [12 Jun 2020] (Travis is no longer used)
  3. Adjusted sphinx main documentation [2 Sep 2020] (Now out of date)

With regard to deployment to Diamond Kubernetes I don't think any of the playbooks are used ... unless someone has deployed the stack to Diamond without my/our knowledge (which is unlikely).

The playbooks for deployment to STFC's Kubernetes are all contained in this new fork and the two AWX servers (in the dev and prod clusters) have now been updated to use this new fork as a source.

I have also updated ReadTheDocs to generate new pages from the new repository.

Our original repository has now been "archived" (set to read only) and is no longer used.

In conclusion: -

phraenquex commented 9 months ago

@Waztom, @mwinokan who of you gets this action?

Waztom commented 9 months ago

@Waztom will look into this.

Waztom commented 9 months ago

@alanbchristie will ping link/info to delete.

alanbchristie commented 9 months ago

The old ReadTheDocs link, which now needs to be removed is: -