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

Added wiki pages to the repo #948

Merged
merged 4 commits into from
Oct 9, 2023
Merged

Conversation

EcksDy
Copy link
Contributor

@EcksDy EcksDy commented Sep 24, 2023

Extracted wiki into a wiki/ folder, as discussed in #887.
Relevant changes are to the main.yml workflow.

======

  • DO keep pull requests small so they can be easily reviewed.

Before merging the PR:

  • CHECK continous integration of main branch is green.
  • CHECK pull request check job is green.
  • CHECK all pull request questions/requests are resolved.
  • WAIT till PR is approved by at least 1 committer.

@EcksDy EcksDy changed the title Issue #887 Added wiki pages to the repo Sep 24, 2023
Copy link
Collaborator

@djelinek djelinek left a comment

Choose a reason for hiding this comment

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

Hello, I am sorry I did not had time to take a look earlier. Thank you for your work and your PR!

I have started the review currently and it looks fine.

One question, is it necessary to clean up current Wiki page or do you have some experience with this gh action?

another question would be, are you able to point here in PR to changes/updates you did against current version of Wiki page, if any?

.github/workflows/main.yml Outdated Show resolved Hide resolved
@EcksDy
Copy link
Contributor Author

EcksDy commented Oct 4, 2023

@djelinek
Thanks for taking a look :)

One question, is it necessary to clean up current Wiki page or do you have some experience with this gh action?

That's a good question, tbh I don't. It seemed to work on my fork once the wiki was created.
I think it would be a good idea to clear the wiki pages and do a "reset".

another question would be, are you able to point here in PR to changes/updates you did against current version of Wiki page, if any?

I intentionally didn't, in case the wiki is going to change until this PR is merged.
After it's merged I intend to make a PR with the few changes I wanted to make originally.
I admit they're not that many ahahah

I also need to copy the current wiki files into the repo again in case any changes happened since I started.

.github/workflows/main.yml Outdated Show resolved Hide resolved
@EcksDy
Copy link
Contributor Author

EcksDy commented Oct 4, 2023

  • Copied the current state of the wiki
  • Extracted the publish job into its own workflow
  • Workflow is triggered by changes to the workflow file(.github/workflows/publish-wiki.yml) or the wiki/ directory
  • Using a better action for what we want to achieve, I've found it when looked at the repo of the previous one
    • This one will completely r-sync the wiki directory with the wiki
    • Requires no configuration

@djelinek
Copy link
Collaborator

djelinek commented Oct 6, 2023

@EcksDy could you please do a rebase and resolve a conflict with main?

@djelinek
Copy link
Collaborator

djelinek commented Oct 6, 2023

  • Copied the current state of the wiki

  • Extracted the publish job into its own workflow

  • Workflow is triggered by changes to the workflow file(.github/workflows/publish-wiki.yml) or the wiki/ directory

  • Using a better action for what we want to achieve, I've found it when looked at the repo of the previous one

    • This one will completely r-sync the wiki directory with the wiki
    • Requires no configuration

LGTM, thanks for the update

@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@djelinek djelinek linked an issue Oct 9, 2023 that may be closed by this pull request
@djelinek djelinek added this to the 5.10.0 milestone Oct 9, 2023
@djelinek djelinek merged commit 0a88a13 into redhat-developer:main Oct 9, 2023
12 checks passed
@djelinek djelinek removed this from the 5.10.0 milestone Oct 9, 2023
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.

[Request] Expose Wiki files to "docs" folder
2 participants