Skip to content

online english manual is blank, Chinese manual is partially visible, Please check the source code! #3186

Open
@wyzhihai

Description

@wyzhihai

image
image

Activity

changed the title [-]online english manual is blank, Chinese manual is partial[/-] [+]online english manual is blank, Chinese manual is partial, Please check the sourcecode![/+] on Jun 29, 2024
changed the title [-]online english manual is blank, Chinese manual is partial, Please check the sourcecode![/-] [+]online english manual is blank, Chinese manual is partially visible, Please check the source code![/+] on Jun 29, 2024
awxiaoxian2020

awxiaoxian2020 commented on Jun 29, 2024

@awxiaoxian2020
Contributor
AgostinoX

AgostinoX commented on Jun 29, 2024

@AgostinoX

I confirm that I cannot read content (english version).

Jason7158

Jason7158 commented on Jul 2, 2024

@Jason7158

Also need the annotation documentation!

Hugh-Ross4

Hugh-Ross4 commented on Jul 2, 2024

@Hugh-Ross4

Lots of people impacted by this. Any alternative links to MyBatis-3 documentation that are still working?
Thanks..

harawata

harawata commented on Jul 2, 2024

@harawata
Member

Hi,

I'm sorry for the inconvenience.
I think @hazendaz is working on it.

For the meantime, please use the wayback machine.
https://web.archive.org/web/20240303085253/https://mybatis.org/mybatis-3/index.html

Or you can build the site locally.

git clone https://github.com/mybatis/mybatis-3.git
cd mybatis-3
git checkout mybatis-3.5.16
./mvnw clean site -Dlicense.skip=true -Dmaven.test.skip=true

The HTMLs will be generated in ./target/site/ directory.

I would recommend modifying the locales in the pom.xml to shorten the build time.

diff --git a/pom.xml b/pom.xml
index a8413790a2..43ce196258 100644
--- a/pom.xml
+++ b/pom.xml
@@ -442,7 +442,7 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-site-plugin</artifactId>
         <configuration>
-          <locales>default,es,ja,fr,zh_CN,ko</locales>
+          <locales>default</locales>
         </configuration>
       </plugin>
       <plugin>
hazendaz

hazendaz commented on Jul 3, 2024

@hazendaz
Member

@harawata I did run the 'site' GHA and it ran ok, the files were updated, but noticed the site never published to org.mybatis. Do you know if there is something else missing there or maybe does it exclude showing snapshots? I'd hate to do a formal release with really no reason other than site but if that is the case, we probably could do so but in that case, let me release the parent again to pickup a few additional items from maven. I know this could be worse, maven broke half their sites documentation due to using maven 4 to run the site for 3. Not the case here but seems documentation problems all over.

harawata

harawata commented on Jul 3, 2024

@harawata
Member

@hazendaz ,

When I ran ./mvnw site against the master locally, the English site is blank (same as the online site), so I assumed that there was some issue with Markdown processor.
Does it generate the site correctly on your machine?

hazendaz

hazendaz commented on Jul 3, 2024

@hazendaz
Member

Thanks @harawata I'll give a try in a few days. Maybe the original defect that resulting in changing the locales is now fixed again. Maven is having a bumpy right here. It is nice to see its problematic locally so I'll give it a shot and see what I can come up with. Will be this coming weekend..

harawata

harawata commented on Jul 3, 2024

@harawata
Member

I have reverted the site to 3.5.16 version, so it should be fine for now.
If someone finds a way to fix the blank site, please send us a PR.

hazendaz

hazendaz commented on Jan 1, 2025

@hazendaz
Member

Latest site is posted, I think this is fixed, can @wyzhihai confirm its working correctly now?

awxiaoxian2020

awxiaoxian2020 commented on Jan 1, 2025

@awxiaoxian2020
Contributor

Latest site is posted, I think this is fixed, can @wyzhihai confirm its working correctly now?

I think #3194 just a workaround. Maybe we should open this for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @harawata@hazendaz@AgostinoX@Jason7158@wyzhihai

        Issue actions

          online english manual is blank, Chinese manual is partially visible, Please check the source code! · Issue #3186 · mybatis/mybatis-3