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

Adding the "just for docs" templet used for Oniro project #8

Closed
wants to merge 5 commits into from

Conversation

Yueqi777
Copy link
Contributor

No description provided.

Copy link
Contributor

@Stefan-Schmidt Stefan-Schmidt left a comment

Choose a reason for hiding this comment

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

For this (and the other commit) you need to write a better commit message. It would need to state what you do here (adding the just the docs template), why are you doing it (we want to use it as the template for our docs.

The format is normally to have a one line subject which summarizes the change and a longer commit message explaining the details.

_config.yml Outdated
@@ -2,7 +2,7 @@ title: Oniro
description: A starter template for a Jeykll site using the Just the Docs theme!
theme: just-the-docs

url: https://Yueqi77-amazing/eclipse-oniro4openharmony.github.io
url: https://github.com/Yueqi777/eclipse-oniro4openharmony.github.io.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Both of these URLs need to be set correctly for the organization name instead of your user account at github.

Copy link
Contributor

@Stefan-Schmidt Stefan-Schmidt left a comment

Choose a reason for hiding this comment

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

Both commits also need a signed off by line (git adds them when you pass -s for the git commit)

@Yueqi777 Yueqi777 changed the title to see if eclipse ok Add the "just for doc" templet to apply for oniro project Nov 14, 2023
@Yueqi777 Yueqi777 changed the title Add the "just for doc" templet to apply for oniro project Add the "just for docs" templet to apply for oniro project Nov 14, 2023
@Yueqi777 Yueqi777 changed the title Add the "just for docs" templet to apply for oniro project Adding the "just for docs" templet used for Oniro project Nov 14, 2023
@Stefan-Schmidt
Copy link
Contributor

@Yueqi777 you only changed the pull request description but not the actual commit message of the individual commits.
https://docs.oniroproject.org/en/latest/contributing/gitlab.html#commit-guidelines
Please se the example in this section how a commit message should look like.

Signed off by lines are still missing.

Please squash the three config change commits into one. There is no need to have all the individual steps.

@Stefan-Schmidt
Copy link
Contributor

@Yueqi77-amazing I took the freedom and take your commits (keep your authorship) and fix up all parts to get it through ECA. Also added some basic docs a start. Please have a look to see what I did there: #9

Please do not feel discouraged by this. Your next pull request will be much better after this learning and you can avoid the same mistakes! :-)

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