Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Migrate documentation to docs.artemis.cit.tum.de #7298

Merged
merged 6 commits into from
Oct 16, 2023

Conversation

ignacio-gn
Copy link
Member

@ignacio-gn ignacio-gn commented Sep 30, 2023

Checklist

General

Motivation and Context

The documentation of Artemis is going to be hosted on docs.artemis.cit.tum.de instead of the GitHubPages environment, ls1intum.github.io. This PR modifies the docs workflow to deploy the artifact on docs.artemis.cit.tum.de. It also replaces all occurrences of ls1intum.github.io in the repository to docs.artemis.cit.tum.de.

Description

On .github/workflows/docs.yml, the docs job was modified to not edit the built artifact for it to be deployed on GitHubPages. The deploy job was modified to download the artifact and upload it to docs.artemis.tum.de.

Repository-wide occurrences of ls1intum.github.io were changed to docs.artemis.cit.tum.de. This includes:

  • Markdown files, including multiple READMEs and the pull request template,
  • Comments/Javadoc that reference the documentation
  • Elements in the web app that link to the documentation
  • The baseURL attribute of the DocumentationButtonComponent and its test instance

Steps for Testing

The workflow has been tested together with the server-side configuration. This PR does not modify the functionality of Artemis.

@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) documentation template docker labels Sep 30, 2023
@ignacio-gn ignacio-gn changed the title Development: Change Development: Migrate documentation to docs.artemis.cit.tum.de Sep 30, 2023
@ignacio-gn ignacio-gn changed the title Development: Migrate documentation to docs.artemis.cit.tum.de 'Development': Migrate documentation to docs.artemis.cit.tum.de Sep 30, 2023
@ignacio-gn ignacio-gn changed the title 'Development': Migrate documentation to docs.artemis.cit.tum.de 'Development: Migrate documentation to docs.artemis.cit.tum.de Sep 30, 2023
@ignacio-gn ignacio-gn changed the title 'Development: Migrate documentation to docs.artemis.cit.tum.de Development: Migrate documentation to docs.artemis.cit.tum.de Sep 30, 2023
@ignacio-gn ignacio-gn added client Pull requests that update TypeScript code. (Added Automatically!) and removed client Pull requests that update TypeScript code. (Added Automatically!) labels Sep 30, 2023
@github-actions
Copy link

github-actions bot commented Oct 7, 2023

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

@github-actions github-actions bot added the stale label Oct 7, 2023
@ignacio-gn ignacio-gn marked this pull request as ready for review October 16, 2023 19:08
@ignacio-gn ignacio-gn requested a review from a team as a code owner October 16, 2023 19:08
@ignacio-gn
Copy link
Member Author

The workflow has been succesfully tested and the server was configured. An (outdated) version of the documentation was deployed to https://docs.artemis.cit.tum.de using this workflow.

@krusche krusche added this to the 6.6.1 milestone Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) docker documentation no-stale ready for review server Pull requests that update Java code. (Added Automatically!) tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants