openliberty / archived-guide-microprofile-intro Goto Github PK

In the EndPointTest.java, if we comment out one test case such as

@Test
    public void testSuite() {
        this.testEmptyInventory();
        // this.testHostRegistration();
        this.testSystemPropertiesMatch();
        this.testUnknownHost();
    }

Then run mvn clean install again, the following test case will fail.
Although if we run all 4 test cases together, they will all pass.
It means that each test case is not independent, which is an issue.

Change the title from Congratulations! You’re done! to Good work! You’re done!

Leave the subsequent text as is, but strip "Congratulations" from it if it appears anywhere.

The very first json snippet is missing formatting:

 {
    "hosts": {
      "localhost": {
       "os.name": "Mac OS X",
       "user.name": "foo"
     },
     "jon-doe": {
       "os.name": "Windows 10",
       "user.name": "bar"
     }
    },
    "total": 2
  }

It should be labelled with [source, json]

I found that the problem is caused by missing some configuration in the pom.xml file.

             <goals>
                <goal>package-server</goal>
              </goals>
         //this part is missing in pom.xml files for some guides, need to be added
             <configuration>
               <outputDirectory>target/wlp-package</outputDirectory>
             </configuration>
           

@gcharters and I need to finish re-reviewing this guide to work out how to tighten its focus and structure, which should hopefully shorten it and simplify the structure of headings listed on the left, and also remove duplication with other guides (eg Maven guide).

I've intentionally assigned this to myself but I won't get to it straight away.

Many links are broken in the readme page. For example:

• ../guides-common//gitclone.adoc
• link:finish/src/main/java/io/openliberty/guides/microprofile/InventoryResource.java[] (his is actually meant to be link right?)

If no one is not already working on this, I can take a shot at it. Please let me know.

Main problems
Some of the links have not been updated to reflect the code changes. For example, the guide still mentions the endpoint systems which we used in the original draft of the code, but it has been replaced by hosts. There was also a link pointing to inventory/properties which is completely invalid since it doesn't actually serve anything. Some minor issues as well like not being clear what files should be created, explanations in wrong parts, etc.

Other problems
The guide doesn't really flow that well. Each section feels like a new chapter. There are also a lot of unclear sentences that definitely need to be rewritten to get their point across better. The guide is also quite long and can probably be refactored to be less shorter.

Currently, any text that is tagged as (effectively) a code snippet is displayed with a 'copy' button that appears on hover in the top right. However, some of the 'code snippets' are actually just console output or are bits of code that the user has already copied but are being called out for more detailed explanation.

I propose tagging console output as class="console" and called out bits of code snippet as class="callout".

Passed requirement to Design to see whether the styles should be any more than just removing the copy button for those classes.

Not sure if this Issue goes here or somewhere else... I've communicated this to @yeekangc, but I thought an Issue would be the best way to track the request...

We need to ensure that all of the MicroProfile-related guides are properly tagged with both the MicroProfile and Microservice(s) tag. I don't know whether to use the singular or plural version of Microservice. But, we need potential users to find all of the MicroProfile guides when searching on any of these tags -- microprofile, microservice, and microservices.

Thanks!

Apply role=“no_copy” to code snippets that are not intended to be copied (eg because they're just repeating sub-snippets and the user shouldn't copy/paste them).

You need to activate that modules (but they will be removed later), or you need to add these new dependencies at least (I prefer this):

<dependency>
  <groupId>javax.xml.bind</groupId>
  <artifactId>jaxb-api</artifactId>
  <version>2.3.0</version>
</dependency>

<dependency>
    <groupId>javax.activation</groupId>
    <artifactId>activation</artifactId>
    <version>1.1.1</version>
</dependency>

'mvn clean install' is failing if you don't skip test.

I got "Context Root Not Found" in the start demo

http://localhost:9080/inventory/hosts

How can we create uber jar for openLiberty ? So that it can be run as

java -jar app.jar 

There is a new header field page-related-guides which can be used for referencing similar guides to the current one. We should this to the existing guides.

Ex of commit: OpenLiberty/guide-rest-intro@78b23fd
Ex on dev site (on the side and near the bottom): https://openlibertydev.mybluemix.net/guides/rest-intro.html

In these lines:

"First, create the JAX-RS service that serves as the systems endpoint:
src/main/java/io/openliberty/guides/microprofile/InventoryResource.java
[code snippet to paste in]"

Two people misunderstood this step and weren't sure what they were supposed to do to create the JAX-RS service (neither experienced in Java but one was a non-Java developer in the past). I think maybe the first 'copy-and-paste-this-snippet' step needs to be more explicit in each guide. eg:

"First, create the JAX-RS service that serves as the systems endpoint. To do this, create an empty file with this file name and paste the following code into it, then save the file:
src/main/java/io/openliberty/guides/microprofile/InventoryResource.java
[code snippet to paste in]"

If we can get the wording of the first step right (and fix issue #21), I think the rest of the steps will be clear enough.

We should test the new wording before pushing to live.

I just did the static "Creating a MicroProfile Application" guide in prep for creating a VM image for a Think conference lab. Everything worked out quite well, but I have a couple of observations...

In the Testing Section, we need to highlight that we're dealing with a totally separate directory structure.

First off, I would pre-create the src/test/java/it/io/openliberty/guides/microprofile/ directory structure in the "start" directory. You had pre-created the development (src/main/java/io/openliberty/guides/microprofile/), so do the same for the "it" test directory.

(BTW, that comment should apply to all of the guides. Not just this MicroProfile guide. I just haven't had the chance to test out all the rest yet...)

And, then within this Testing Section, you need to highlight the fact that we are now working in the totally separate "it" directory structure. If you read this too quickly (which I did), you will notice the tiny "it" and assume you are still talking about the development directory structure. And, you get some pretty strange build errors if you put the testing files in the development structure. The maven dependencies don't work right. And, then you try to correct them, and then you get strange compile errors... It's just a mess.

Hope this was clear. Thanks!

This MP Intro is now superseded by the combination of the REST Intro and CDI Intro guides.

We should archive this guide. Should check that after it is archived, it won't show up on searches on openliberty.io. Then, direct URL access should still return the guide should it has been bookmarked.

Should have a banner to redirect to new(er) guides too.